fidget 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 053aecb8ac134a93352ee94ad74e2b5d53391157
-  data.tar.gz: a03308997ca134b329f148f477865d630b336efb
+  metadata.gz: 071950c0536d7b69138334ac835bd62b2fb905e6
+  data.tar.gz: 144764a39998a5493f86d9a44af78e33db43d053
 SHA512:
-  metadata.gz: e891bb9f07dab6e7c6406cb1693cc59c84cf3ad3fce0f02741010af879d88e63cb9c982190ac418e53afa5fc63e981de9ed59d5d33ee97ed999ec053aaf76349
-  data.tar.gz: 75076bdb11679fe0e55c2df30e62a03ef218d64e841923e2569113e5b7c7c795728f86eee6bdb96e6661f24eff86ea61674226a7aac82779a007ee8bb0af6d1d
+  metadata.gz: 02a03445b97d4f61a5ccccd827d1e747cdc850b57076395c99faa40cead70ad6967df6d78e77d97477c2a38b46ecda15341d13a8b9e45aca210eac0e33dfabc9
+  data.tar.gz: 9dcbb6fe00c3cb618f98b44754cd3fb164b68770237c5bc1cf11098ffe0c495142fb537375eb0d476aafef7808b1a72b138d04efc682f1ff2718c37fa79021d1

data/README.md

@@ -1,12 +1,26 @@
 # Fidget
 A cross platform tool to prevent your computer from sleeping.
 
+
 ## Overview
 
-Usage : `fidget [-o <options>] [command]`
+Do you really dig `caffeinate` on OS X and wish that you could use it on
+Windows? Are you building something that supports multiple platforms and
+need the display to stay on without much fuss? Does the phrase "[Yes.
+`gnome-screensaver` has a simple to use DBus API for this](https://wiki.gnome.org/Projects/GnomeScreensaver/FrequentlyAskedQuestions#I.27m_developing_an_application_that_has_a_fullscreen_mode.__Is_there_a_way_that_I_can_disable_the_screensaver.3F)"
+make you irrationally angry?
+
+If so, this might be the tool for you. Fidget provides both a commandline
+tool and a library to simply and easily inhibit sleep on all major platforms.
+
+
+## Usage
 
-Sleep options may very between platforms. Each platform will include at least
-the following core options:
+    $ fidget [-o <options>] [command]
+
+Options should be passed as a comma-separated list.  Sleep options may very
+between platforms. Each platform will include at least the following core
+options:
 
   * `display` will prevent the display from sleeping.
   * `sleep` prevent the system from sleeping.
@@ -26,10 +40,28 @@ Additional Linux options:
 
   * `blanking` disables terminal blanking on Linux.
 
-If you pass the a command, then Fidget will execute that command and prevent
-the system from sleeping until that command terminates. If you do not provide a
+If you pass a command, then Fidget will execute that command and prevent the
+system from sleeping until that command terminates. If you do not provide a
 command, then Fidget will prevent sleeping until you press Ctrl-C to terminate.
 
+### Examples
+
+Simply keep the computer from sleeping until you press Ctrl-C
+
+    $ fidget
+    System has been prevented from sleeping.
+    - Press Ctrl-C to resume normal power management.
+
+Pass options and run a command
+
+    $ fidget -o sleep,idle make
+
+
+## Installation
+
+    $ gem install fidget
+
+
 ## Library Usage
 
 There are three methods you may use in your programs. The `options` parameter
@@ -45,7 +77,7 @@ or symbols.
 * `Fidget.current_process(options)`
     * Shortcut method to inhibit sleep during the execution of the current process.
 
-### Example usages:
+### Examples
 
 Default options, with a block:
 
@@ -100,7 +132,10 @@ Simply prevent the computer from sleeping while the current process is running:
 
 ## Limitations
 
-This is super early in development and has not yet been battle tested.
+This is super early in development and has not yet been battle tested. If you
+discover a platform it doesn't work on, or a use case that it should cover,
+please do [file an issue](https://github.com/binford2k/fidget/issues)
+
 
 ## Disclaimer
 

data/bin/fidget

@@ -22,6 +22,7 @@ Additional OS X options:
 
 Additional Windows options:
   * 'away' enables a low-power, but not sleeping, mode on Windows.
+  * `simulate` will simulate a user keyboard action every few seconds.
 
 Additional Linux options:
   * 'blanking' disables terminal blanking on Linux.
@@ -35,10 +36,15 @@ command, then Fidget will prevent sleeping until you press Ctrl-C to terminate.
         options = arg.split(',').map{ |e| e.to_sym }
     end
 
-    opts.on("-d", "--debug", "Display or log debugging messages") do
+    opts.on("-d", "--debug", "Display debugging messages") do
         loglevel = Logger::DEBUG
     end
 
+    opts.on("-v", "--version", "Display the version of Fidget") do
+        puts Fidget::VERSION
+        exit(0)
+    end
+
     opts.separator('')
 
     opts.on("-h", "--help", "Displays this help") do
@@ -64,5 +70,5 @@ begin
     sleep
   end
 rescue Interrupt => e
-  puts "Normal power management resumed."
+  puts "\nNormal power management resumed."
 end

data/lib/fidget.rb

@@ -1,4 +1,6 @@
 class Fidget
+  require 'fidget/version'
+
   case Gem::Platform.local.os
   when /darwin/
     require 'fidget/platform/darwin'
@@ -31,8 +33,8 @@ class Fidget
     end
   end
 
-  def self.allow_sleep(handle)
-    Fidget::Platform.allow_sleep(handle)
+  def self.allow_sleep
+    Fidget::Platform.allow_sleep
   end
 
 end

data/lib/fidget/platform/linux.rb

@@ -22,7 +22,7 @@ class Fidget::Platform
     pid
   end
 
-  def self.allow_sleep(handle)
+  def self.allow_sleep
     options = munge(options)
     resume(options)
   end
@@ -61,9 +61,10 @@ class Fidget::Platform
       # This is possibly because the inhibit expires when the dbus-session command terminates
       # I don't know if this will work in other distros though. Yay for consistency. *\o/*
       begin
-        dbus_screensaver.Inhibit(root_win, 'Administratively disabled')
+        @@cookie = dbus_screensaver.Inhibit(root_win, 'Administratively disabled')
       rescue => e
         STDERR.puts 'Fidget: DBus action failed.'
+        STDERR.puts e.message
         STDERR.puts e.backtrace.join "\n"
       end
     end

data/lib/fidget/platform/windows.rb

@@ -29,7 +29,7 @@ class Fidget::Platform
     pid
   end
 
-  def self.allow_sleep(handle)
+  def self.allow_sleep
     set_state(nil)
   end
 

data/lib/fidget/version.rb

@@ -1,3 +1,3 @@
 class Fidget
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fidget
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Ford