RubyGems - screen-recorder - Versions diffs - 1.0.0 → 1.1.0 - Mend

screen-recorder 1.0.0 → 1.1.0

Files changed (23) hide show

checksums.yaml +4 -4
data/.github/ISSUE_TEMPLATE.md +7 -5
data/.gitignore +99 -107
data/.rspec +3 -3
data/.rubocop.yml +45 -37
data/.travis.yml +35 -32
data/CHANGES.md +78 -70
data/LICENSE.txt +21 -21
data/README.md +218 -210
data/Rakefile +6 -1
data/bin/console +0 -0
data/bin/setup +8 -8
data/lib/screen-recorder.rb +53 -45
data/lib/screen-recorder/common.rb +146 -127
data/lib/screen-recorder/desktop.rb +40 -30
data/lib/screen-recorder/errors.rb +9 -9
data/lib/screen-recorder/options.rb +151 -148
data/lib/screen-recorder/titles.rb +49 -81
data/lib/screen-recorder/type_checker.rb +11 -11
data/lib/screen-recorder/version.rb +2 -2
data/lib/screen-recorder/window.rb +22 -22
data/screen-recorder.gemspec +40 -31
metadata +54 -21

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554e522713dae29caa579b2645498635c021cc12a3de77cba2b905215abbd4cd
-  data.tar.gz: 37d995de354b476b9b03d97c20961dfae0d4a700de34640b23c84ba29e9cc4ac
+  metadata.gz: f46c2cd0518ebc956772cc5586b95974e0f51cede0d456ff0934bb2aaa9cef92
+  data.tar.gz: a8f5113b23a9a3521a282e9385f7c8502e01991594ee065eb6cf5a55fd6403f3
 SHA512:
-  metadata.gz: e1d21d41f96ef133eade14aa3477609c30ffe482c4a8530095643a9fc6b8f3357c78d36dae19b38489f9386782ccc227bf79b2d48d54d59a87d51f4be6fdb258
-  data.tar.gz: d3b9e5727224acf8415d43ae71f093e9aec72c81ab553f5bfd994c67f81f87b7af68e7ab8bc3c2c2bf8481377507b7bcd094b436bee7ccb4bc5e60ecd2e02ff8
+  metadata.gz: '059777ec5a7b09f8c1bf97727c57f07cf4172918a445aa1015544b92cb4bf8454ea6d5c79daaf8aab0667aad132ec6fcb466ce52cc365f05cb9f598fd8266445'
+  data.tar.gz: 0ecbe285d1a4d6f9fd6f579c9233614d6e8e1f0130ab31d9f40ba2f348e2dac8ba3d1cc82f9fc0f0340f2f1215fec9e89f89996688dce76ab26bc7c7efc42034

data/.github/ISSUE_TEMPLATE.md CHANGED Viewed

@@ -1,15 +1,17 @@
 ### Summary
-A clear and concise description of what the bug is.
+Short summary of the bug or feature request.
 ### Debug Info
-Please provide the following information:
+Please provide the following information for bug reports:
 * Operating system - Microsoft Windows, Linux, or macOS.
-* `opts` Hash used for the recorder.
+* Recorder parameters - input, output, etc.
 * Recorder log (`ffmpeg.log`) file as a gist or on pastebin.com.
-* Set `log_level: Logger::DEBUG`, run the recorder, and share the
+* Set `ScreenRecorder.logger.level = Logger::DEBUG`, run the recorder, and share the
 console output as a gist or on pastebin.com.
 ### Expected Behavior
+What you expect to happen.
-### Actual Behavior
+### Actual Behavior
+What is actually happening.

data/.gitignore CHANGED Viewed

@@ -1,108 +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
-# User-specific stuff
-.idea/
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-# 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
-.idea/misc.xml
-*.ipr
+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 CHANGED Viewed

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

data/.rubocop.yml CHANGED Viewed

@@ -1,50 +1,58 @@
-Style/EndOfLine:
-  EnforcedStyle: crlf
+require: rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: false
+  TargetRubyVersion: 2.2
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 Metrics/LineLength:
-  Max: 120
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+  EnforcedStyle: indented_relative_to_receiver
+Layout/AlignArray:
+  Enabled: true
+Layout/AlignHash:
+  Enabled: true
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: table
+Layout/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_first_parameter
+Layout/EndOfLine:
+  Enabled: false
+Layout/IndentHash:
+  Enabled: true
+Naming/FileName:
+  Enabled: false
+RSpec/FilePath:
+  Enabled: false
 Style/BlockDelimiters:
   EnforcedStyle: braces_for_chaining
 Style/CommentedKeyword:
   Enabled: false
 Style/DoubleNegation:
   Enabled: false
-Metrics/MethodLength:
-  Max: 18
-Metrics/PerceivedComplexity:
-  Max: 10
-Metrics/CyclomaticComplexity:
-  Max: 8
-Metrics/AbcSize:
-  Max: 20
 Style/MethodCallWithoutArgsParentheses:
   Enabled: false
-Style/Documentation:
-  Enabled: false
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: when_needed, always, never
 Style/FrozenStringLiteralComment:
   Enabled: false
 TrailingBlankLines:
-  Enabled: false
-Layout/MultilineMethodCallIndentation:
   Enabled: false

data/.travis.yml CHANGED Viewed

@@ -1,32 +1,35 @@
----
-sudo: required
-dist: xenial
-language: ruby
-cache: bundler
-branches:
-  only:
-    - /.*/
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.1
-env:
-  - DISPLAY=":0.0"
-addons:
-  firefox: latest
-  chrome: stable
-before_install:
-  - gem update --system --no-document
-before_script:
-  - sudo apt-get install -y ffmpeg
-  - ffmpeg -hwaccels
-  - sudo apt-get install wmctrl
-script: xvfb-run --server-num=0.0 --server-args="-ac -screen 0 1024x768x24" bundle exec rake spec
+---
+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 &

data/CHANGES.md CHANGED Viewed

@@ -1,71 +1,79 @@
-### 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.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.