screen-recorder 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f46c2cd0518ebc956772cc5586b95974e0f51cede0d456ff0934bb2aaa9cef92
-  data.tar.gz: a8f5113b23a9a3521a282e9385f7c8502e01991594ee065eb6cf5a55fd6403f3
+  metadata.gz: 4d582b8454520bac8dd7e3dd11b8f81bb8c76d42c9612bad0d246573583ead4e
+  data.tar.gz: bc2780669046dc0c21c87574cead28a3a4cbae13fc36e30fe110671c162b2b94
 SHA512:
-  metadata.gz: '059777ec5a7b09f8c1bf97727c57f07cf4172918a445aa1015544b92cb4bf8454ea6d5c79daaf8aab0667aad132ec6fcb466ce52cc365f05cb9f598fd8266445'
-  data.tar.gz: 0ecbe285d1a4d6f9fd6f579c9233614d6e8e1f0130ab31d9f40ba2f348e2dac8ba3d1cc82f9fc0f0340f2f1215fec9e89f89996688dce76ab26bc7c7efc42034
+  metadata.gz: 608c366a5ed1bd079ea48f939dcd79fd775830340ecd20453f89442f2b9dda6581d8051dfc24507606d9f9a037e9293f799e1df114cd722d3aaba82a2241de65
+  data.tar.gz: 6b6a5b9aeadf5385a6d28e2ed2c55070b5203e1214057f70200476178179f3236ee916d7844434f3320088816d7ff6a650536866c7ae3508ddf2e86a7fc7bf30

data/.gitignore

@@ -1,100 +1,100 @@
-Gemfile.lock # Part of best practice
-
-# Created by https://www.gitignore.io/api/rubymine+all
-
-### RubyMine+all ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/webdrivers_bin
-*.log
-*.mkv
-*.mp4
-*.avi
-*.gif
-
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status
-
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-
-# CMake
-cmake-build-*/
-
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
-# File-based project format
-*.iws
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-# Editor-based Rest Client
-.idea/httpRequests
-
-# Android studio 3.1+ serialized cache file
-.idea/caches/build_file_checksums.ser
-
-### RubyMine+all Patch ###
-# Ignores the whole .idea folder and all .iml files
-# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
-
-.idea/
-
-# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
-
-*.iml
-modules.xml
-*.ipr
-
-.DS_Store # On mac
-
+Gemfile.lock # Part of best practice
+
+# Created by https://www.gitignore.io/api/rubymine+all
+
+### RubyMine+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/webdrivers_bin
+*.log
+*.mkv
+*.mp4
+*.avi
+*.gif
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### RubyMine+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+*.ipr
+
+.DS_Store # On mac
+
 # End of https://www.gitignore.io/api/rubymine+all

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
---color
---require spec_helper
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -38,7 +38,7 @@ Layout/AlignParameters:
   EnforcedStyle: with_first_parameter
 Layout/EndOfLine:
   Enabled: false
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   Enabled: true
 Naming/FileName:
   Enabled: false

data/.travis.yml

@@ -1,35 +1,49 @@
----
-os:
-  - linux
-  - osx
-dist: xenial
-language: ruby
-cache: bundler
-
-branches:
-  only:
-    - /.*/
-
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.5
-  - 2.6.2
-
-env:
-  - DISPLAY=":0"
-
-addons:
-  firefox: latest
-  apt:
-    packages:
-      - ffmpeg
-  homebrew:
-    packages:
-      - ffmpeg
-
-before_install:
-  - gem update --system --no-document
-
-before_script:
-  - nohup Xvfb :0 -screen 0 1024x768x24 &
+---
+language: ruby
+cache: bundler
+branches:
+  only:
+    - /.*/
+env:
+  global:
+    - DISPLAY=":0"
+matrix:
+  include:
+    - rvm: 2.4.6
+      dist: xenial
+      env: RAKE_TASK=spec
+    - rvm: 2.4.6
+      dist: xenial
+      env: RAKE_TASK=rubocop
+    - rvm: 2.6.3
+      dist: xenial
+      env: RAKE_TASK=spec REPORT_COVERAGE=true
+    - rvm: 2.4.6
+      os: osx
+      env: RAKE_TASK=spec
+    - rvm: 2.6.3
+      os: osx
+      env: RAKE_TASK=spec
+addons:
+  firefox: latest
+  chrome: stable
+  apt:
+    packages:
+      - ffmpeg
+  homebrew:
+    packages:
+      - ffmpeg
+before_script:
+  - if [[ "$RAKE_TASK" == "spec" ]]; then
+      nohup Xvfb :0 -screen 0 1024x768x24 &
+    fi
+  - if [[ "$REPORT_COVERAGE" == "true" ]] && [[ "$TRAVIS_BRANCH" == "master" ]]; then
+      curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter;
+      chmod +x ./cc-test-reporter;
+      ./cc-test-reporter before-build;
+    fi
+script: bundle exec rake $RAKE_TASK
+after_script:
+  - if [[ "$REPORT_COVERAGE" == "true" ]] && [[ "$TRAVIS_BRANCH" == "master" ]]; then
+      ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT;
+    fi

data/CHANGES.md

@@ -1,79 +1,90 @@
-### 1.1.0 (2019-04-14)
-* <b>Add support for macOS</b> ([#55](https://github.com/kapoorlakshya/screen-recorder/issues/55)). Please [raise an Issue](https://github.com/kapoorlakshya/screen-recorder/issues/new) if you run into problems.
-* Force kill `ffmpeg` if it takes more than 10s to quit ([#60](https://github.com/kapoorlakshya/screen-recorder/issues/60)).
-* Fix a bug where `ScreenRecorder.ffmpeg_binary=()` was not properly defined.
-* `ScreenRecorder::Titles#fetch` will now raise `NotImplementedError` when used in a 
-Linux or a macOS environment. Only works on Windows.
-* Default `input` value on Linux is now `:0`.
-
-### 1.0.0 (2019-03-15)
-* Released first major version.
-* Now uses `ScreenRecorder` as top level module. `FFMPEG` is not directly 
-exposed anymore.
-* The recording modes are now available through `ScreenRecorder::Desktop` 
-and `ScreenRecorder::Window` classes to make the usage (parameters) simpler.
-* Method parameters are now keywords instead of an `opts` Hash. This means
-at least Ruby 2.0.0 is required.
-* `framerate:` is now to be passed through the `advanced` Hash. 
-
-### 1.0.0.beta13 (2019-03-15)
-* Gem will now be renamed to `screen-recorder`. Please refer to Issue 
-[#45](https://github.com/kapoorlakshya/screen-recorder/issues/45)
-for more information.
-
-### 1.0.0.beta12 (2019-03-12)
-* Reverted post install message as `screen_recorder` is already taken.
-
-### 1.0.0.beta11 (2019-03-12)
-* Recording FPS (`framerate`) is defaulted to 15.0.
-* Gem will soon be renamed to `screen_recorder`. Please refer to Issue 
-[#45](https://github.com/kapoorlakshya/screen-recorder/issues/45)
-for more information.
-
-### 1.0.0.beta10 (2019-02-05)
-* Fixed an edge case in Microsoft Windows specific implementation of
-`WindowTitles#fetch` where processes with mismatching names and window
-titles, such as process `"Calculator.exe"` with window title `"CicMarshalWnd"`,
-were omitted ([#35](https://github.com/kapoorlakshya/screen-recorder/issues/35)).
-This fix also prints a warning when this mismatch occurs.
-* Fixed bug in Linux specific `WindowTitles#fetch` implementation where
-the filter by application name logic was removed. This filter is required
-on Linux here because `wmctrl` returns all open window titles unlike
-Microsoft Windows where `taskmgr` allows us get window titles by process
-name.
-* On Linux, you are now required to provide the `input` as `"desktop"`
-or a display number, such as `":0.0"`. Run `echo $DISPLAY` to check your display number.
-* QOL improvements - Type checking of inputs, spec cleanup, added more
-tests, and fixed rubocop warnings.
-
-### 1.0.0.beta9 (2019-01-22)
-
-* :warning: `FFMPEG::RecordingRegions` is now `FFMPEG::WindowTitles`, so the module name is true to the function it provides.
-* Added support for for a user given path via `FFMPEG#ffmpeg_binary=()`.
-* Removed Bundler version requirement from gemspec to support all versions.
-* Implement `#discard` (alias `#delete`) to discard the video file. Useful when your test passes and you want to get rid of the video file.
-
-### 1.0.0.beta8 (2019-01-03)
-
-* Fix a bug where the gem was incorrectly configured to be required as `ffmpeg/screenrecorder` instead of `screen-recorder`.
-* `ScreenRecorder#start` now returns the IO process object in case the user has a use case for it.
-* `RecordingRegion#fetch` now logs a warning that `x11grab` for Linux does not supporting window recording.
-* :warning: Parameter `infile` is now `input` to make it more intuitive.
-
-### 1.0.0.beta7 (2018-12-23)
-
-* Fix bug in RecorderOptions where an incorrect object was referenced to read the user provided options.
-
-### 1.0.0.beta6 (2018-12-3)
-
-* Stopping the screenrecorder now prints the failure reason given by the ffmpeg binary when `#stop` fails (Issue #7).
-* Log file is now defaulted to `ffmpeg.log` instead of redirecting to nul.
-* `log_level` now defaults to `Logger::ERROR` instead of `Logger::INFO`.
-
-### 1.0.0.beta5 (2018-11-26)
-
-* `Screenrecorder` class is now `ScreenRecorder`.
-* Add support for Linux.
-* Now an exception raised if the gem fails to find `ffmpeg`.
-* Fix a bug where a file named `nul` was created instead of directing the output to `NUL`.
+### 1.2.0 (2019-05-12)
+* Separate input/output specific `ffmpeg` arguments through the `advanced` 
+Hash. See example [here](https://github.com/kapoorlakshya/screen-recorder#advanced-options).
+* Check for errors after starting the `ffmpeg` process to make sure the 
+recording does not stop silently because of an error. Prints the error 
+from the log if the process exists unexpectedly.
+* Now using [`childprocess`](https://github.com/enkessler/childprocess) gem
+to manage the `ffmpeg` process. This requires the  `ffi` gem to be 
+installed on Windows. See [childprocess#132](https://github.com/enkessler/childprocess/issues/150)
+for more information.
+
+### 1.1.0 (2019-04-14)
+* <b>Add support for macOS</b> ([#55](https://github.com/kapoorlakshya/screen-recorder/issues/55)). Please [raise an Issue](https://github.com/kapoorlakshya/screen-recorder/issues/new) if you run into problems.
+* Force kill `ffmpeg` if it takes more than 10s to quit ([#60](https://github.com/kapoorlakshya/screen-recorder/issues/60)).
+* Fix a bug where `ScreenRecorder.ffmpeg_binary=()` was not properly defined.
+* `ScreenRecorder::Titles#fetch` will now raise `NotImplementedError` when used in a 
+Linux or a macOS environment. Only works on Windows.
+* Default `input` value on Linux is now `:0`.
+
+### 1.0.0 (2019-03-15)
+* Released first major version.
+* Now uses `ScreenRecorder` as top level module. `FFMPEG` is not directly 
+exposed anymore.
+* The recording modes are now available through `ScreenRecorder::Desktop` 
+and `ScreenRecorder::Window` classes to make the usage (parameters) simpler.
+* Method parameters are now keywords instead of an `opts` Hash. This means
+at least Ruby 2.0.0 is required.
+* `framerate:` is now to be passed through the `advanced` Hash. 
+
+### 1.0.0.beta13 (2019-03-15)
+* Gem will now be renamed to `screen-recorder`. Please refer to Issue 
+[#45](https://github.com/kapoorlakshya/screen-recorder/issues/45)
+for more information.
+
+### 1.0.0.beta12 (2019-03-12)
+* Reverted post install message as `screen_recorder` is already taken.
+
+### 1.0.0.beta11 (2019-03-12)
+* Recording FPS (`framerate`) is defaulted to 15.0.
+* Gem will soon be renamed to `screen_recorder`. Please refer to Issue 
+[#45](https://github.com/kapoorlakshya/screen-recorder/issues/45)
+for more information.
+
+### 1.0.0.beta10 (2019-02-05)
+* Fixed an edge case in Microsoft Windows specific implementation of
+`WindowTitles#fetch` where processes with mismatching names and window
+titles, such as process `"Calculator.exe"` with window title `"CicMarshalWnd"`,
+were omitted ([#35](https://github.com/kapoorlakshya/screen-recorder/issues/35)).
+This fix also prints a warning when this mismatch occurs.
+* Fixed bug in Linux specific `WindowTitles#fetch` implementation where
+the filter by application name logic was removed. This filter is required
+on Linux here because `wmctrl` returns all open window titles unlike
+Microsoft Windows where `taskmgr` allows us get window titles by process
+name.
+* On Linux, you are now required to provide the `input` as `"desktop"`
+or a display number, such as `":0.0"`. Run `echo $DISPLAY` to check your display number.
+* QOL improvements - Type checking of inputs, spec cleanup, added more
+tests, and fixed rubocop warnings.
+
+### 1.0.0.beta9 (2019-01-22)
+
+* :warning: `FFMPEG::RecordingRegions` is now `FFMPEG::WindowTitles`, so the module name is true to the function it provides.
+* Added support for for a user given path via `FFMPEG#ffmpeg_binary=()`.
+* Removed Bundler version requirement from gemspec to support all versions.
+* Implement `#discard` (alias `#delete`) to discard the video file. Useful when your test passes and you want to get rid of the video file.
+
+### 1.0.0.beta8 (2019-01-03)
+
+* Fix a bug where the gem was incorrectly configured to be required as `ffmpeg/screenrecorder` instead of `screen-recorder`.
+* `ScreenRecorder#start` now returns the IO process object in case the user has a use case for it.
+* `RecordingRegion#fetch` now logs a warning that `x11grab` for Linux does not supporting window recording.
+* :warning: Parameter `infile` is now `input` to make it more intuitive.
+
+### 1.0.0.beta7 (2018-12-23)
+
+* Fix bug in RecorderOptions where an incorrect object was referenced to read the user provided options.
+
+### 1.0.0.beta6 (2018-12-3)
+
+* Stopping the screenrecorder now prints the failure reason given by the ffmpeg binary when `#stop` fails (Issue #7).
+* Log file is now defaulted to `ffmpeg.log` instead of redirecting to nul.
+* `log_level` now defaults to `Logger::ERROR` instead of `Logger::INFO`.
+
+### 1.0.0.beta5 (2018-11-26)
+
+* `Screenrecorder` class is now `ScreenRecorder`.
+* Add support for Linux.
+* Now an exception raised if the gem fails to find `ffmpeg`.
+* Fix a bug where a file named `nul` was created instead of directing the output to `NUL`.
 * Fix a bug where `RecordingRegions#window_titles` was not returning anything because of missing return keyword.