headless 0.0.1 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+## 0.1.0
+* introduced options
+* make it possible to change virtual screen dimensions and pixel depth

data/README.md

@@ -3,6 +3,7 @@
 Headless is a Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding some low-level action.
 
 I created it so I can run Selenium tests in Cucumber without any shell scripting. Even more, you can go headless only when you run tests against Selenium.
+Other possible uses include pdf generation with `wkhtmltopdf`, or screenshotting.
 
 ## Installation
 

data/lib/headless.rb

@@ -35,8 +35,6 @@
 #   headless.destroy
 #--
 # TODO test that reuse actually works with an existing xvfb session
-# TODO maybe write a command-line wrapper like
-#   headlessly firefox
 #++
 class Headless
 
@@ -46,20 +44,27 @@ class Headless
   # The display number
   attr_reader :display
 
-  # Creates a new headless server, but NOT switches to it immediately. Call #start for that
+  # The display dimensions
+  attr_reader :dimensions
+
+  # Creates a new headless server, but does NOT switch to it immediately. Call #start for that
+  #
+  # List of available options:
+  # * +display+ (default 99) - what display number to listen to;
+  # * +reuse+ (default true) - if given display server already exists, should we use it or fail miserably?
+  # * +dimensions+ (default 1280x1024x24) - display dimensions and depth. Not all combinations are possible, refer to +man Xvfb+.
   def initialize(options = {})
-    @xvfb = `which Xvfb`.strip
-    raise Exception.new('Xvfb not found on your system') if @xvfb == ''
+    find_xvfb
 
-    # TODO more options, like display dimensions and depth; set up default dimensions and depth
     @display = options.fetch(:display, 99).to_i
     @reuse_display = options.fetch(:reuse, true)
+    @dimensions = options.fetch(:dimensions, '1280x1024x24')
 
     #TODO more logic here, autopicking the display number
     if @reuse_display
       launch_xvfb unless read_pid
     elsif read_pid
-      raise Exception.neW("Display :#{display} is already taken and reuse=false")
+      raise Exception.new("Display :#{display} is already taken and reuse=false")
     else
       launch_xvfb
     end
@@ -89,8 +94,7 @@ class Headless
   #   Headless.run do
   #     # perform operations in headless mode
   #   end
-  # 
-  # Alias: #ly (Headless.ly)
+  # See #new for options
   def self.run(options={}, &block)
     headless = Headless.new(options)
     headless.start
@@ -103,8 +107,14 @@ class Headless
 private
   attr_reader :xvfb_pid
 
+  def find_xvfb
+    @xvfb = `which Xvfb`.strip
+    raise Exception.new('Xvfb not found on your system') if @xvfb == ''
+  end
+
   def launch_xvfb
-    system "#{@xvfb} :#{display} -ac >/dev/null 2>&1 &"
+    #TODO error reporting
+    system "#{@xvfb} :#{display} -screen 0 #{dimensions} -ac >/dev/null 2>&1 &"
     sleep 1
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: headless
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Leonid Shevtsov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +03:00
+date: 2010-08-16 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/headless.rb
+- CHANGELOG
 - README.md
 - LICENSE
 has_rdoc: true