fidget 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 071950c0536d7b69138334ac835bd62b2fb905e6
-  data.tar.gz: 144764a39998a5493f86d9a44af78e33db43d053
+  metadata.gz: ad59e6d764cbf2bc8910fe3905b909f7efb25c1d
+  data.tar.gz: 675e1df0a3eb686dd15ee958ecd5e82de9c02043
 SHA512:
-  metadata.gz: 02a03445b97d4f61a5ccccd827d1e747cdc850b57076395c99faa40cead70ad6967df6d78e77d97477c2a38b46ecda15341d13a8b9e45aca210eac0e33dfabc9
-  data.tar.gz: 9dcbb6fe00c3cb618f98b44754cd3fb164b68770237c5bc1cf11098ffe0c495142fb537375eb0d476aafef7808b1a72b138d04efc682f1ff2718c37fa79021d1
+  metadata.gz: ec59b3d504006e39b0e881db51b7be974d4897bcb8de11dadc433658773c5d10e5f9cd0b25c80fbdb881586dc55c5ea1f83235211756447a89c02c0c0acac93d
+  data.tar.gz: e1a8fb990e49593ce2f141a183e7715b570db26b854d601385a28ba89553c4fc0c2f55cbb0b9abd65271ffd2a0997204d453da8fec2f0cdaebfa82254db8f259

data/README.md

@@ -30,6 +30,8 @@ Additional OS X options:
 
   * `idle` will prevent the system from idle sleeping.
   * `disk` will prevent the disk from sleeping.
+  * 'user' will assert that the user is active. This keeps the display
+           on and prevents idle sleep.
 
 Additional Windows options:
 
@@ -40,6 +42,11 @@ Additional Linux options:
 
   * `blanking` disables terminal blanking on Linux.
 
+Default options for each platform:
+  * OS X: `user`
+  * Linux: `display`
+  * Windows: `display`,`sleep`
+
 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.
@@ -83,7 +90,7 @@ Default options, with a block:
 
     #! /usr/bin/env ruby
     require 'fidget'
-    
+
     Fidget.prevent_sleep do
       100.times do
         print '.'
@@ -109,12 +116,12 @@ No block, just calling methods:
     require 'fidget'
 
     Fidget.prevent_sleep(:display, :sleep)
-    
+
     100.times do
       print '.'
       sleep 1
     end
-    
+
     Fidget.allow_sleep
 
 Simply prevent the computer from sleeping while the current process is running:
@@ -123,12 +130,12 @@ Simply prevent the computer from sleeping while the current process is running:
     require 'fidget'
 
     Fidget.current_process
-    
+
     100.times do
       print '.'
       sleep 1
     end
-   
+
 
 ## Limitations
 

data/bin/fidget

@@ -19,6 +19,8 @@ the following core options:
 Additional OS X options:
   * 'idle' will prevent the system from idle sleeping.
   * 'disk' will prevent the disk from sleeping.
+  * 'user' will assert that the user is active. This keeps the display
+           on and prevents idle sleep.
 
 Additional Windows options:
   * 'away' enables a low-power, but not sleeping, mode on Windows.
@@ -27,6 +29,11 @@ Additional Windows options:
 Additional Linux options:
   * 'blanking' disables terminal blanking on Linux.
 
+Default options for each platform:
+  * OS X: `user`
+  * Linux: `display`
+  * Windows: `display,sleep`
+
 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
 command, then Fidget will prevent sleeping until you press Ctrl-C to terminate.
@@ -37,7 +44,7 @@ command, then Fidget will prevent sleeping until you press Ctrl-C to terminate.
     end
 
     opts.on("-d", "--debug", "Display debugging messages") do
-        loglevel = Logger::DEBUG
+        Fidget.debuglevel = Logger::DEBUG
     end
 
     opts.on("-v", "--version", "Display the version of Fidget") do

data/lib/fidget.rb

@@ -1,5 +1,6 @@
 class Fidget
   require 'fidget/version'
+  require 'fidget/logger'
 
   case Gem::Platform.local.os
   when /darwin/
@@ -12,18 +13,24 @@ class Fidget
     require 'fidget/platform/windows'
 
   when 'java'
-    STDERR.puts 'When running under jRuby, we cannot reliably manage power settings.'
+    logger.error 'When running under jRuby, we cannot reliably manage power settings.'
     require 'fidget/platform/null'
 
   else
     raise "Unknown platform: #{Gem::Platform.local.os}"
   end
 
-  def self.current_process(options = nil)
+  def self.current_process(*options)
+    simulator(options)
+    options.delete :simulate
+
     Fidget::Platform.current_process(options)
   end
 
-  def self.prevent_sleep(options = nil)
+  def self.prevent_sleep(*options)
+    simulator(options)
+    options.delete :simulate
+
     if block_given?
       Fidget::Platform.prevent_sleep(options) do
         yield
@@ -31,10 +38,33 @@ class Fidget
     else
       Fidget::Platform.prevent_sleep(options)
     end
+
   end
 
   def self.allow_sleep
+    Thread.kill @@simulator if @@simulator
     Fidget::Platform.allow_sleep
   end
 
+  def self.simulator(options)
+    # if :all or :simulate were passed, start up the action simulator
+    unless (options & [:all, :simulate]).empty?
+      @@simulator = Thread.new do
+        loop do
+          Fidget::Platform.simulate
+          sleep 30
+        end
+      end
+
+      # if this is still running, make sure it gets cleaned up
+      at_exit do
+        return unless @@simulator
+        return unless @@simulator.alive?
+        Thread.kill @@simulator
+      end
+    end
+
+  end
+  private_class_method :simulator
+
 end

data/lib/fidget/logger.rb

@@ -0,0 +1,28 @@
+class Fidget
+  require 'logger'
+
+  def self.logger
+    unless @logger
+      @logger = Logger.new(STDERR)
+      @logger.level = Logger::WARN
+    end
+    @logger
+  end
+  private_class_method :logger
+
+  def self.error(message)
+    logger.error(message)
+  end
+
+  def self.warn(message)
+    logger.warn(message)
+  end
+
+  def self.debug(message)
+    logger.debug(message)
+  end
+
+  def self.debuglevel=(level)
+    logger.level = level
+  end
+end

data/lib/fidget/platform/darwin.rb

@@ -29,9 +29,17 @@ class Fidget::Platform
     @@pids = nil
   end
 
-  def self.arguments(*options)
+  def self.simulate
+    # osx needs accessibilty access to do this, along with a big scary prompt.
+    # But it's not really needed anyway. Caffeinate works really well.
+    # Should we want to at some point..., https://github.com/AXElements/AXElements
+  end
+
+
+  def self.arguments(options)
     options.flatten!
     options.compact!
+    return '-u'    if options.empty?
     return '-dism' if options == [:all]
 
     terms = {
@@ -39,6 +47,7 @@ class Fidget::Platform
       :idle    => 'i',
       :disk    => 'm',
       :sleep   => 's',
+      :user    => 'u',
     }
     options.each do |opt|
       STDERR.puts "Fidget: option #{opt} is not supported on OS X" unless terms.include? opt

data/lib/fidget/platform/linux.rb

@@ -2,6 +2,7 @@ class Fidget::Platform
   require "dbus"
 
   def self.current_process(options)
+    return false unless required_binaries
     options = munge(options)
     suspend(options)
 
@@ -11,6 +12,7 @@ class Fidget::Platform
   end
 
   def self.prevent_sleep(options)
+    return false unless required_binaries
     options = munge(options)
     suspend(options)
 
@@ -23,11 +25,17 @@ class Fidget::Platform
   end
 
   def self.allow_sleep
+    return false unless required_binaries
     options = munge(options)
     resume(options)
   end
 
-  def self.munge(*options)
+  def self.simulate
+    return false unless required_binaries('xset')
+    system('xset reset')
+  end
+
+  def self.munge(options)
     options.flatten!
     options.compact!
     options = [:display] if options.empty?
@@ -65,7 +73,7 @@ class Fidget::Platform
       rescue => e
         STDERR.puts 'Fidget: DBus action failed.'
         STDERR.puts e.message
-        STDERR.puts e.backtrace.join "\n"
+        STDERR.puts e.backtrace.first
       end
     end
 
@@ -101,4 +109,16 @@ class Fidget::Platform
   end
   private_class_method :dbus_screensaver
 
+  def self.required_binaries(*list)
+    list = ['xset', 'xdg-screensaver', 'xwininfo'] if list.empty?
+    found = true
+    list.each do |command|
+      unless system("which #{command} > /dev/null 2>&1")
+        found = false
+        Fidget.debug "Fidget: required binary (#{command}) not found."
+      end
+    end
+    found
+  end
+  private_class_method :required_binaries
 end

data/lib/fidget/platform/null.rb

@@ -0,0 +1,24 @@
+class Fidget::Platform
+  def self.current_process(options)
+    false
+  end
+
+  def self.prevent_sleep(options)
+    return false
+
+    # prevent sleep
+    if block_given?
+      yield
+      # allow sleep
+    end
+  end
+
+  def self.allow_sleep
+    false
+  end
+
+  def self.simulate
+    false
+  end
+
+end

data/lib/fidget/platform/windows.rb

@@ -33,10 +33,17 @@ class Fidget::Platform
     set_state(nil)
   end
 
+  def self.simulate
+    # memoized so we don't keep loading the library every few seconds
+    @@kb ||= Win32API.new('user32.dll', 'keybd_event', 'IILL', 'V')
+    @@kb.call(KB_KEY_F24, 0, KB_EVENT_KEYPRESS, 0)
+    @@kb.call(KB_KEY_F24, 0, KB_EVENT_KEYUP, 0)
+  end
+
   # Set thread execution state, using information from
   # https://msdn.microsoft.com/en-us/library/aa373208(VS.85).aspx
   # http://stackoverflow.com/questions/4126136/stop-a-windows-7-pc-from-going-to-sleep-while-a-ruby-program-executes
-  def self.set_state(*options)
+  def self.set_state(options)
     options.flatten!
     options.compact!
     options = [:display, :sleep] if options.empty?
@@ -57,20 +64,6 @@ class Fidget::Platform
     state = Win32API.new('kernel32','SetThreadExecutionState','L')
     state.call(ES_CONTINUOUS|mode)
 
-    if options.include? :simulate
-      @@kb_poker = Thread.new do
-        kb = Win32API.new('user32.dll', 'keybd_event', 'nnnn', 'v')
-        loop do
-          kb.call(KB_KEY_F24, 0, KB_EVENT_KEYPRESS, nil)
-          kb.call(KB_KEY_F24, 0, KB_EVENT_KEYUP, nil)
-          sleep 30
-        end
-      end
-    end
-
-    if options.nil?
-      Thread.kill @@kb_poker if @@kb_poker
-    end
   end
   private_class_method :set_state
 

data/lib/fidget/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fidget
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
@@ -42,8 +42,10 @@ files:
 - README.md
 - LICENSE
 - bin/fidget
+- lib/fidget/logger.rb
 - lib/fidget/platform/darwin.rb
 - lib/fidget/platform/linux.rb
+- lib/fidget/platform/null.rb
 - lib/fidget/platform/windows.rb
 - lib/fidget/version.rb
 - lib/fidget.rb