ffprober 0.4.6 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f48bb0db1f7f7a981b59f158ab245b6570f173f6
-  data.tar.gz: d6c4ab9014aaf6f000ae11db448620f15002fe7d
+SHA256:
+  metadata.gz: 7d8c232d9ed83bd2d51a9ff879008d26deadc3ddf62970cca4e9e15ad118c01f
+  data.tar.gz: b13c5c21ac3942019be942f242d06c3d63d577c9332940dbd1e7e2bb3768f364
 SHA512:
-  metadata.gz: 2996def445326304ff4ccafa381a855a43f5503a244b22bde01c5731c8b48aa50faae084b9e9985684710534cd2003ea1ca06c3837d1b029cf173045c1a42b4f
-  data.tar.gz: e2dd182e05eeaaeff74d9c59bff424358a9ff831a07b7ccf530ed76612c76dd1af82c5be850d03ccf7110a0ea3f33ca131e0352cd136c11223efa5a8e61ca7a3
+  metadata.gz: 994061aa59b82948a63d753ca191c7a501e5d474117c67231ddd3131ef0574a51750693c697cafdd45269af7c29817619ef32a3405f5ac6988501ceef2d45b2e
+  data.tar.gz: 1209f4ff0162d55cc019d5434d87b0236e6bbb6b13b87a58c0a665e97ebc2701e6a5668e08580348497e36e48210a8efd4897c317f7b376e4cbc849a2c3f9007

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,73 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
 
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+## Our Standards
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+Examples of behavior that contributes to creating a positive environment
+include:
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ich@abwesend.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/Changes.md

@@ -1,3 +1,43 @@
+1.0 / 2020-11-28
+==========
+
+* added Sorbet types
+* added a bunch of Rubocops
+
+0.5.5 / 2020-03-28
+==========
+
+* no code changes, i had to release to to make sure that GitHub Actions are working
+
+0.5.4 / 2020-03-28
+==========
+
+* due to security issues in rake, the minimum version is now 12.3.3
+
+0.5.3 / 2019-02-16
+==========
+
+* fixed running on older ffmpeg versions. (PR: https://github.com/beanieboi/ffprober/pull/83) thanks @sevilla
+
+0.5.2 / 2017-01-18
+==========
+
+* exposes a from_url method that allows probing URLs
+* validates URL input and raises error if invalid URL
+* raises an error if ffprobe responses with an error message in the JSON
+
+0.5.1 / 2016-02-07
+===================
+
+* expose parsed json via ffprober.json
+
+0.5.0 / unreleased
+===================
+
+* autoload, reduce initial object count by 3k
+* refactorings, clean up warnings etc.
+* remove check for maximum ffprober version, makes upgrading ffmpeg way easier
+
 0.4.6 / 2015-11-12
 ===================
 

data/Gemfile

@@ -1,8 +1,12 @@
-source "https://rubygems.org"
+# typed: strong
+# frozen_string_literal: true
 
-gem "pry"
-gem "rubocop"
-gem "codeclimate-test-reporter", require: nil
+source 'https://rubygems.org'
+
+group :test do
+  gem 'simplecov'
+  gem 'sorbet'
+end
 
 # Specify your gem's dependencies in ffprober.gemspec
 gemspec

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 
 ## FFMPEG version
 
-tested with ffprobe version 0.9 upto 2.2
+tested with ffprobe version 0.9 upto 4.3.1
 
 according to [ffmpeg changelog](http://git.videolan.org/?p=ffmpeg.git;a=blob_plain;f=Changelog) json output was added in version 0.9
 
@@ -43,13 +43,13 @@ help me collecting various version outputs of fprobe/ffmpeg
 
 ## Supported Rubies
 
-Ffprober is tested under 2.0, 2.1, JRuby (head) and Rubinius and ruby-head.
+Ffprober is tested under 2.4, 2.5, 2.6 and 2.7.
 
-[![Build Status](https://secure.travis-ci.org/beanieboi/ffprober.png?branch=master)](http://travis-ci.org/beanieboi/ffprober)
+[![Build Status](https://github.com/beanieboi/ffprober/workflows/Ruby/badge.svg)](https://github.com/beanieboi/ffprober/actions?query=workflow%3ARuby)
 
-[![Code Climate](https://codeclimate.com/github/beanieboi/ffprober.png)](https://codeclimate.com/github/beanieboi/ffprober)
+[![Maintainability](https://api.codeclimate.com/v1/badges/34d393657d54b233ebbc/maintainability)](https://codeclimate.com/github/beanieboi/ffprober/maintainability)
 
-[![Test Coverage](https://codeclimate.com/github/beanieboi/ffprober/badges/coverage.svg)](https://codeclimate.com/github/beanieboi/ffprober)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/34d393657d54b233ebbc/test_coverage)](https://codeclimate.com/github/beanieboi/ffprober/test_coverage)
 
 ## Contributors
 

data/ffprober.gemspec

@@ -1,26 +1,44 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# typed: strong
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ffprober/version"
+require 'ffprober/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ffprober"
+  spec.name          = 'ffprober'
   spec.version       = Ffprober::VERSION
-  spec.authors       = ["beanieboi"]
-  spec.email         = ["beanie@benle.de"]
+  spec.authors       = ['beanieboi']
+  spec.email         = ['beanie@benle.de']
 
-  spec.description   = %q{a Ruby wrapper for ffprobe}
-  spec.summary       = %q{a Ruby wrapper for ffprobe (part of ffmpeg)}
-  spec.homepage      = "https://github.com/beanieboi/ffprober"
-  spec.license       = "MIT"
+  spec.description   = 'a Ruby wrapper for ffprobe'
+  spec.summary       = 'a Ruby wrapper for ffprobe (part of ffmpeg)'
+  spec.homepage      = 'https://github.com/beanieboi/ffprober'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.files         = Dir[
+     'CODE_OF_CONDUCT.md',
+     'CONTRIBUTING.md',
+     'Changes.md',
+     'Gemfile',
+     'ffprober.gemspec',
+     'lib/**/*',
+     'LICENSE',
+     'README.md'
+    ]
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.add_runtime_dependency 'sorbet-runtime'
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rubocop', '~> 1'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-packaging'
+  spec.add_development_dependency 'rubocop-sorbet'
+  spec.add_development_dependency 'simplecov', '~> 0.19'
 end

data/lib/ffprober.rb

@@ -1,23 +1,51 @@
-require_relative "ffprober/version"
-require_relative "ffprober/dynamic_initializer"
-require_relative "ffprober/parser"
-require_relative "ffprober/format"
-require_relative "ffprober/stream"
-require_relative "ffprober/audio_stream"
-require_relative "ffprober/data_stream"
-require_relative "ffprober/video_stream"
-require_relative "ffprober/subtitle_stream"
-require_relative "ffprober/chapter"
-require_relative "ffprober/ffprobe_version"
-require_relative "ffprober/wrapper"
-require_relative "ffprober/errors"
-
-require_relative "ffprober/ffmpeg/finder"
-require_relative "ffprober/ffmpeg/version"
-require_relative "ffprober/ffmpeg/version_validator"
-require_relative "ffprober/parsers/file"
-require_relative "ffprober/parsers/json"
-require "json"
+# typed: true
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup
+
+require 'sorbet-runtime'
+require_relative 'ffprober/version'
+
+autoload :JSON, 'json'
 
 module Ffprober
+  class EmptyInput < StandardError; end
+
+  class InvalidInputFileError < StandardError; end
+
+  class NoFfprobeFound < StandardError; end
+
+  class UnsupportedVersion < StandardError; end
+
+  class FfprobeError < StandardError
+    def initialize(ff_err)
+      super("Ffprobe responded with: #{ff_err[:string]} (#{ff_err[:code]})")
+    end
+  end
+
+  autoload :AudioStream, 'ffprober/audio_stream'
+  autoload :Chapter, 'ffprober/chapter'
+  autoload :DataStream, 'ffprober/data_stream'
+  autoload :DynamicInitializer, 'ffprober/dynamic_initializer'
+  autoload :FfprobeVersion, 'ffprober/ffprobe_version'
+  autoload :Format, 'ffprober/format'
+  autoload :Parser, 'ffprober/parser'
+  autoload :Stream, 'ffprober/stream'
+  autoload :SubtitleStream, 'ffprober/subtitle_stream'
+  autoload :VideoStream, 'ffprober/video_stream'
+  autoload :Wrapper, 'ffprober/wrapper'
+
+  module Ffmpeg
+    autoload :Exec, 'ffprober/ffmpeg/exec'
+    autoload :Finder, 'ffprober/ffmpeg/finder'
+    autoload :Version, 'ffprober/ffmpeg/version'
+    autoload :VersionValidator, 'ffprober/ffmpeg/version_validator'
+  end
+
+  module Parsers
+    autoload :FileParser, 'ffprober/parsers/file'
+    autoload :UrlParser, 'ffprober/parsers/url'
+    autoload :JsonParser, 'ffprober/parsers/json'
+  end
 end

data/lib/ffprober/audio_stream.rb

@@ -1,3 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
 module Ffprober
   class AudioStream < Stream
   end

data/lib/ffprober/chapter.rb

@@ -1,3 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
 module Ffprober
   class Chapter
     include Ffprober::DynamicInitializer

data/lib/ffprober/data_stream.rb

@@ -1,3 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
 module Ffprober
   class DataStream < Stream
   end

data/lib/ffprober/dynamic_initializer.rb

@@ -1,13 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
 module Ffprober
   module DynamicInitializer
+    include Kernel
+
     def initialize(object_attribute_hash)
       object_attribute_hash.each do |key, value|
         instance_variable_set("@#{key}", value)
 
-        unless self.class.method_defined?(key)
-          self.class.send(:define_method, key) do
-            instance_variable_get("@#{key}")
-          end
+        next if self.class.method_defined?(key)
+
+        self.class.send(:define_method, key) do
+          instance_variable_get("@#{key}")
         end
       end
     end

data/lib/ffprober/ffmpeg/exec.rb

@@ -0,0 +1,51 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'shellwords'
+
+module Ffprober
+  module Ffmpeg
+    class Exec
+      extend T::Sig
+
+      CHAPTER_SUPPORT = T.let(Gem::Version.new('2.0.0'), Gem::Version)
+
+      sig { params(finder: T.any(Ffprober::Ffmpeg::Finder, T.untyped)).void }
+      def initialize(finder = Ffprober::Ffmpeg::Finder.new)
+        @finder = finder
+        @ffprobe_version_output = T.let(nil, T.nilable(String))
+      end
+
+      sig { params(filename: String).returns(String) }
+      def json_output(filename)
+        `#{@finder.path} #{ffprobe_options} #{Shellwords.escape(filename)}`
+      end
+
+      sig { returns(String) }
+      def ffprobe_version_output
+        @ffprobe_version_output ||= begin
+          if @finder.path.nil?
+            ''
+          else
+            `#{@finder.path} -version`
+          end
+        end
+      end
+
+      sig { returns(String) }
+      def ffprobe_options
+        base_options = '-v quiet -print_format json -show_format'\
+                       ' -show_streams -show_error'
+
+        options = "#{base_options} -show_chapters" if ffprobe_version.version >= CHAPTER_SUPPORT
+
+        options || base_options
+      end
+
+      sig { returns(Ffprober::Ffmpeg::Version) }
+      def ffprobe_version
+        Ffprober::Ffmpeg::Version.new(self)
+      end
+    end
+  end
+end

data/lib/ffprober/ffmpeg/finder.rb

@@ -1,22 +1,50 @@
+# typed: strong
+# frozen_string_literal: true
+
 module Ffprober
   module Ffmpeg
     class Finder
-      def self.path
-        @path ||= begin
-          path = ENV["PATH"].split(File::PATH_SEPARATOR).detect do |path_to_check|
-            File.executable?(File.join(path_to_check, executable_name))
-          end
+      extend T::Sig
+      SEARCH_PATHS = T.let(ENV['PATH'], T.nilable(String))
 
-          path && File.expand_path(executable_name, path)
-        end
+      sig { returns(String) }
+      attr_reader :executable_name
+
+      sig { void }
+      def initialize
+        @executable_path = T.let(nil, T.nilable(String))
+        @executable_name = T.let(executable_name_picker, String)
+        @path = T.let(nil, T.nilable(String))
+      end
+
+      sig { returns(String) }
+      def path
+        raise Ffprober::NoFfprobeFound, 'ffprobe executable not found' if executable_path.nil?
+
+        @path ||= File.expand_path(executable_name, executable_path)
+      end
+
+      sig { returns(T::Boolean) }
+      def windows?
+        !(RUBY_PLATFORM =~ /(mingw|mswin)/).nil?
       end
 
-      def self.executable_name
-        @executable_name ||= self.windows? ? "ffprobe.exe" : "ffprobe"
+      sig { returns(String) }
+      def executable_name_picker
+        if windows?
+          T.let('ffprobe.exe', String)
+        else
+          T.let('ffprobe', String)
+        end
       end
 
-      def self.windows?
-        !!(RUBY_PLATFORM =~ /(mingw|mswin)/)
+      sig { returns(T.nilable(String)) }
+      def executable_path
+        @executable_path ||= begin
+          T.must(SEARCH_PATHS).split(File::PATH_SEPARATOR).detect do |path_to_check|
+            File.executable?(File.join(path_to_check, executable_name))
+          end
+        end
       end
     end
   end