headless 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecdab81182658752d292ec13079deae78ed26241
+  data.tar.gz: 2f61437e9fe159aa2160e45263f731e20a43ffb8
+SHA512:
+  metadata.gz: ca8f638bd43c1ddbda26171974b2c4bd11e0508d5c973c5ce35553658e8e647df8bb9027fa62e31c00fde382bf8f87ebd352d762904e3bddefc653169b8b5731
+  data.tar.gz: af8d46f3c14dbc2d0f8bea5bdfc04e7b2e917f878ac208abcf91f30c3bbc5f66582540c488b8a89b97f76527f4da0e825e0a6d6e6af715160d78b3ad4d7283a2

data/CHANGELOG

@@ -1,3 +1,8 @@
+## 1.0.2 (2014-06-03)
+
+* pass options correctly to ffmpeg (from @abotalov)
+* only destroy headless if it was created (from @evandrodp)
+
 ## 1.0.1 (2013-02-20)
 
 * when starting, wait for Xvfb to launch (fixed issue #33)

data/README.md

@@ -16,71 +16,75 @@ Documentation is available at [rdoc.info](http://rdoc.info/projects/leonid-shevt
 
 On Debian/Ubuntu:
 
-    sudo apt-get install xvfb
-    gem install headless
+```sh
+sudo apt-get install xvfb
+gem install headless
+```
 
 ## Usage
 
 Block mode:
 
-    require 'rubygems'
-    require 'headless'
-    require 'selenium-webdriver'
+```ruby
+require 'rubygems'
+require 'headless'
+require 'selenium-webdriver'
 
-    Headless.ly do
-      driver = Selenium::WebDriver.for :firefox
-      driver.navigate.to 'http://google.com'
-      puts driver.title 
-    end
+Headless.ly do
+  driver = Selenium::WebDriver.for :firefox
+  driver.navigate.to 'http://google.com'
+  puts driver.title 
+end
+```
 
 Object mode:
 
-    require 'rubygems'
-    require 'headless'
-    require 'selenium-webdriver'
+```ruby
+require 'rubygems'
+require 'headless'
+require 'selenium-webdriver'
 
-    headless = Headless.new
-    headless.start
+headless = Headless.new
+headless.start
 
-    driver = Selenium::WebDriver.for :firefox
-    driver.navigate.to 'http://google.com'
-    puts driver.title
+driver = Selenium::WebDriver.for :firefox
+driver.navigate.to 'http://google.com'
+puts driver.title
 
-    headless.destroy
+headless.destroy
+```
 
 ## Cucumber
 
 Running cucumber headless is now as simple as adding a before and after hook in `features/support/env.rb`:
 
+```ruby
+# change the condition to fit your setup
+if Capybara.current_driver == :selenium
+  require 'headless'
 
-    # change the condition to fit your setup
-    if Capybara.current_driver == :selenium
-      require 'headless'
-
-      headless = Headless.new
-      headless.start
-    end
+  headless = Headless.new
+  headless.start
+end
+```
 
 ## Running tests in parallel
 
 If you have multiple threads running acceptance tests in parallel, you want to spawn Headless before forking, and then reuse that instance with `destroy_at_exit: false`.
 You can even spawn a Headless instance in one ruby script, and then reuse the same instance in other scripts by specifying the same display number and `reuse: true`.
 
-    # spawn_headless.rb
-    Headless.new(display: 100, destroy_at_exit: false).start
-
-
-    # test_suite_that_could_be_ran_multiple_times.rb
-    headless = Headless.new(display: 100, reuse: true, destroy_at_exit: false)
-    # Xvfb is already started by the first script
-
-    # reap_headless.rb 
-    headless = Headless.new(display: 100, reuse: true)
-    headless.destroy
-
+```ruby
+# spawn_headless.rb
+Headless.new(display: 100, destroy_at_exit: false).start
 
+# test_suite_that_could_be_ran_multiple_times.rb
+Headless.new(display: 100, reuse: true, destroy_at_exit: false).start
 
-    
+# reap_headless.rb 
+headless = Headless.new(display: 100, reuse: true)
+headless.destroy
+```
+ 
 
 ## Cucumber with wkhtmltopdf
 
@@ -88,29 +92,33 @@ _Note: this is true for other programs which may use headless at the same time a
 
 When wkhtmltopdf is using Headless, and cucumber is invoking a block of code which uses a headless session, make sure to override the default display of cucumber to retain browser focus. Assuming wkhtmltopdf is using the default display of 99, make sure to set the display to a value != 99 in `features/support/env.rb` file. This may be the cause of `Connection refused - connect(2) (Errno::ECONNREFUSED)`.
 
-    headless = Headless.new(:display => '100')
-    headless.start
+```ruby
+headless = Headless.new(:display => '100')
+headless.start
+```
 
 ## Capturing video
 
 Video is captured using `ffmpeg`. You can install it on Debian/Ubuntu via `sudo apt-get install ffmpeg` or on OS X via `brew install ffmpeg`. You can capture video continuously or capture scenarios separately. Here is typical use case:
 
-    require 'headless'
+```ruby
+require 'headless'
 
-    headless = Headless.new
-    headless.start
+headless = Headless.new
+headless.start
 
-    Before do
-      headless.video.start_capture
-    end
+Before do
+  headless.video.start_capture
+end
 
-    After do |scenario|
-      if scenario.failed?
-        headless.video.stop_and_save("/tmp/#{BUILD_ID}/#{scenario.name.split.join("_")}.mov")
-      else
-        headless.video.stop_and_discard
-      end
-    end
+After do |scenario|
+  if scenario.failed?
+    headless.video.stop_and_save("/tmp/#{BUILD_ID}/#{scenario.name.split.join("_")}.mov")
+  else
+    headless.video.stop_and_discard
+  end
+end
+```
 
 ## Taking screenshots
 
@@ -123,3 +131,8 @@ Images are captured using `import` utility which is part of `imagemagick` librar
 ---
 
 © 2011 Leonid Shevtsov, released under the MIT license
+
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/leonid-shevtsov/headless/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/headless.gemspec

@@ -3,7 +3,7 @@ spec = Gem::Specification.new do |s|
   s.email = 'leonid@shevtsov.me'
 
   s.name = 'headless'
-  s.version = '1.0.1'
+  s.version = '1.0.2'
   s.summary = 'Ruby headless display interface'
 
   s.description = <<-EOF

data/lib/headless.rb

@@ -107,7 +107,7 @@ class Headless
     headless.start
     yield headless
   ensure
-    headless.destroy
+    headless && headless.destroy
   end
   class <<self; alias_method :ly, :run; end
 

data/lib/headless/video/video_recorder.rb

@@ -8,7 +8,7 @@ class Headless
       CliUtil.ensure_application_exists!('ffmpeg', 'Ffmpeg not found on your system. Install it with sudo apt-get install ffmpeg')
 
       @display = display
-      @dimensions = dimensions
+      @dimensions = dimensions[/.+(?=x)/]
 
       @pid_file_path = options.fetch(:pid_file_path, "/tmp/.headless_ffmpeg_#{@display}.pid")
       @tmp_file_path = options.fetch(:tmp_file_path, "/tmp/.headless_ffmpeg_#{@display}.mov")

data/spec/headless_spec.rb

@@ -9,7 +9,7 @@ describe Headless do
   context "instantiation" do
     context "when Xvfb is not installed" do
       before do
-        Headless::CliUtil.stub!(:application_exists?).and_return(false)
+        Headless::CliUtil.stub(:application_exists?).and_return(false)
       end
 
       it "raises an error" do
@@ -33,8 +33,8 @@ describe Headless do
 
     context "when Xvfb is already running" do
       before do
-        Headless::CliUtil.stub!(:read_pid).with('/tmp/.X99-lock').and_return(31337)
-        Headless::CliUtil.stub!(:read_pid).with('/tmp/.X100-lock').and_return(nil)
+        Headless::CliUtil.stub(:read_pid).with('/tmp/.X99-lock').and_return(31337)
+        Headless::CliUtil.stub(:read_pid).with('/tmp/.X100-lock').and_return(nil)
       end
 
       context "and display reuse is allowed" do
@@ -72,8 +72,8 @@ describe Headless do
 
     context 'when Xvfb is started, but by another user' do
       before do
-        Headless::CliUtil.stub!(:read_pid).with('/tmp/.X99-lock') { raise Errno::EPERM }
-        Headless::CliUtil.stub!(:read_pid).with('/tmp/.X100-lock').and_return(nil)
+        Headless::CliUtil.stub(:read_pid).with('/tmp/.X99-lock') { raise Errno::EPERM }
+        Headless::CliUtil.stub(:read_pid).with('/tmp/.X100-lock').and_return(nil)
       end
 
       context "and display autopicking is not allowed" do
@@ -116,7 +116,7 @@ describe Headless do
 
     describe "#destroy" do
       before do
-        Headless::CliUtil.stub!(:read_pid).and_return(4444)
+        Headless::CliUtil.stub(:read_pid).and_return(4444)
       end
 
       it "switches back from the headless server and terminates the headless session" do
@@ -148,7 +148,7 @@ describe Headless do
     let(:headless) { Headless.new }
 
     it "raises an error if imagemagick is not installed" do
-      Headless::CliUtil.stub!(:application_exists?).and_return(false)
+      Headless::CliUtil.stub(:application_exists?).and_return(false)
 
       lambda { headless.take_screenshot }.should raise_error(Headless::Exception)
     end
@@ -165,9 +165,9 @@ describe Headless do
 private
 
   def stub_environment
-    Headless::CliUtil.stub!(:application_exists?).and_return(true)
-    Headless::CliUtil.stub!(:read_pid).and_return(nil)
-    Headless::CliUtil.stub!(:path_to).and_return("/usr/bin/Xvfb")
+    Headless::CliUtil.stub(:application_exists?).and_return(true)
+    Headless::CliUtil.stub(:read_pid).and_return(nil)
+    Headless::CliUtil.stub(:path_to).and_return("/usr/bin/Xvfb")
 
     # TODO this is wrong. But, as long as Xvfb is started inside the constructor (which is also wrong), I don't see another option to make tests pass
     Headless.any_instance.stub(:ensure_xvfb_is_running).and_return(true)

data/spec/video_recorder_spec.rb

@@ -7,7 +7,7 @@ describe Headless::VideoRecorder do
 
   describe "instantiation" do
     before do
-      Headless::CliUtil.stub!(:application_exists?).and_return(false)
+      Headless::CliUtil.stub(:application_exists?).and_return(false)
     end
 
     it "throws an error if ffmpeg is not installed" do
@@ -17,16 +17,16 @@ describe Headless::VideoRecorder do
 
   describe "#capture" do
     it "starts ffmpeg" do
-      Headless::CliUtil.stub(:path_to, 'ffmpeg').and_return('ffmpeg')
-      Headless::CliUtil.should_receive(:fork_process).with(/ffmpeg -y -r 30 -g 600 -s 1024x768x32 -f x11grab -i :99 -vcodec qtrle/, "/tmp/.headless_ffmpeg_99.pid", '/dev/null')
+      Headless::CliUtil.stub(:path_to).and_return('ffmpeg')
+      Headless::CliUtil.should_receive(:fork_process).with(/ffmpeg -y -r 30 -g 600 -s 1024x768 -f x11grab -i :99 -vcodec qtrle/, "/tmp/.headless_ffmpeg_99.pid", '/dev/null')
 
       recorder = Headless::VideoRecorder.new(99, "1024x768x32")
       recorder.start_capture
     end
 
     it "starts ffmpeg with specified codec" do
-      Headless::CliUtil.stub(:path_to, 'ffmpeg').and_return('ffmpeg')
-      Headless::CliUtil.should_receive(:fork_process).with(/ffmpeg -y -r 30 -g 600 -s 1024x768x32 -f x11grab -i :99 -vcodec libvpx/, "/tmp/.headless_ffmpeg_99.pid", '/dev/null')
+      Headless::CliUtil.stub(:path_to).and_return('ffmpeg')
+      Headless::CliUtil.should_receive(:fork_process).with(/ffmpeg -y -r 30 -g 600 -s 1024x768 -f x11grab -i :99 -vcodec libvpx/, "/tmp/.headless_ffmpeg_99.pid", '/dev/null')
 
       recorder = Headless::VideoRecorder.new(99, "1024x768x32", {:codec => 'libvpx'})
       recorder.start_capture
@@ -67,7 +67,7 @@ describe Headless::VideoRecorder do
 private
 
   def stub_environment
-    Headless::CliUtil.stub!(:application_exists?).and_return(true)
-    Headless::CliUtil.stub!(:fork_process).and_return(true)
+    Headless::CliUtil.stub(:application_exists?).and_return(true)
+    Headless::CliUtil.stub(:fork_process).and_return(true)
   end
 end

metadata

@@ -1,59 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: headless
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.0.2
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description: ! '    Headless is a Ruby interface for Xvfb. It allows you to create
-  a headless display straight from Ruby code, hiding some low-level action.
-
-'
+description: |2
+      Headless is a Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding some low-level action.
 email: leonid@shevtsov.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -67,33 +60,26 @@ files:
 - spec/video_recorder_spec.rb
 homepage: http://leonid.shevtsov.me/en/headless
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3030427348639260588
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3030427348639260588
 requirements:
 - Xvfb
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby headless display interface
 test_files: []