breaktime 0.1.3 → 0.1.4

data/README.md

@@ -1,6 +1,6 @@
 # Breaktime
 
-Breaktime loves your eyes. That's why it gives them a screen break every so often - as often as you like. It hides in the background, waiting for it's moment to shine. When it's time for you to take a break it opens a dialog box with a timer counting down from 10, giving you the chance to cancel. But when the timer hits zero your screensaver will pop up, forcing you to go and make some tea/coffee/mojitos.
+Breaktime loves your eyes. That's why it gives them a screen break every so often - as often as you like. It hides in the background, waiting for it's moment to shine. When it's time for you to take a break it opens a dialog box with a timer counting down from 10, giving you the chance to cancel or delay the break by 5 minutes. But when the timer hits zero your screensaver will pop up, forcing you to go and make some tea/coffee/mojitos.
 
 You can set how often it runs, which day(s) of the week it runs, and which system command you want to execute when it's time for a break. All of this can be configured with some lovely YAML.
 
@@ -25,24 +25,35 @@ SYNOPSIS
   breaktime (start|stop|dialog|now) [options]+
 
 DESCRIPTION
-  Give your eyes scheduled screen breaks
+  Give your eyes scheduled screen breaks by starting up the screensaver at
+  regular intervals. By default it will give you a break every 60 minutes.
+  It is configurable via a YAML file which sits at $HOME/.breaktime.yml by
+  default.
+
+USAGE
+  breaktime (start) - start breaktime, as a daemon by default
+  breaktime stop    - stop a daemonized process
+  breaktime now     - run the command to have a break instantly
+  breaktime dialog  - show the countdown dialog box
 
 PARAMETERS
-  --config, -c <s>:   Configuration yaml file (default: /home/jon/.breaktime.yml)
-   --level, -l <s>:   Output level = (debug|info|warn|error|fatal) (default: info)
-        --help, -h:   Show this message
+    --config, -c <s>:   Configuration yaml file (default: /home/jon/.breaktime.yml)
+  --pid-file, -p <s>:   PID file path, used when daemonizing (default: /home/jon/breaktime.pid)
+  --log-file, -l <s>:   Log file path (default: /home/jon/breaktime.log)
+     --level, -o <s>:   Output level = (debug|info|warn|error|fatal) (default: info)
+          --help, -h:   Show this message
 ```
 
 Simply running `breaktime` on its own should work - it will run every 60 minutes by default, and will try and work out the right screensaver command for your OS and window manager. If it can't work out your OS, then you can just set the **command** in the YAML file (read on).
 
+You can set the log and pid file that will be used when daemonizing the process. This will allow you to see what's going on, and will allow only one instance of breaktime to run, respectively.
+
 If you want to do a bit more fine-tuning, create a YAML file at `$HOME/.breaktime.yml` that looks like this (everything's optional):
 
 ```yml
 command: xscreensaver-command -a
 interval: 40
 daemonize: true
-log_file: /path/to/log/file.log
-pid_file: /path/to/pid/file.pid
 days:
   - monday
   - tuesday
@@ -54,8 +65,6 @@ days:
 * **command** is the system command run every break time
 * **interval** is the time, in minutes, between each break
 * **daemonize** says whether the scheduling should run as a background process (daemon)
-* **log_file** specifies the file that output is written to (only if **daemonize** is true)
-* **pid_file** specifies the file that contains the PID (only if **daemonize** is true)
 * **days** allows you to specify which days of the week to run it
 
 If you want your YAML file to be elsewhere, then just pass it as the `--config` parameter to the breaktime command.

data/lib/breaktime.rb

@@ -12,6 +12,7 @@ module Breaktime
   EX_LINUX_WM_UNKNOWN = 3  # Unknown window manager (linux)
   EX_SIGNAL = 128          # Process signal caught
   EX_INTERRUPT = 130       # Control-C caught
+  EX_BREAK_DELAYED = 253   # Delay from the countdown GUI
   EX_BREAK_CANCELLED = 254 # Cancel from the countdown GUI
   EX_CLI = 255             # CLI option errors
 

data/lib/breaktime/cli.rb

@@ -7,7 +7,8 @@ class Breaktime::CLI
   SUB_COMMANDS = %w(start stop dialog now)
 
   # Default location of YAML config file.
-  DEFAULT_CONFIG = ENV['HOME'] + File::SEPARATOR + ".breaktime.yml"
+  HOME = ENV['HOME'] + File::SEPARATOR
+  DEFAULT_CONFIG = HOME + '.breaktime.yml'
 
   def initialize
     @options = parse_cli_options
@@ -26,8 +27,8 @@ SYNOPSIS
   breaktime (#{SUB_COMMANDS.join("|")}) [options]+
 
 DESCRIPTION
-  Give your eyes scheduled screen breaks by starting up the screensaver at 
-  regular intervals. By default it will give you a break every 60 minutes. 
+  Give your eyes scheduled screen breaks by starting up the screensaver at
+  regular intervals. By default it will give you a break every 60 minutes.
   It is configurable via a YAML file which sits at $HOME/.breaktime.yml by
   default.
 
@@ -40,14 +41,24 @@ USAGE
 PARAMETERS
 BAN
 
-      opt :config, 
-          "Configuration yaml file", 
-          :short => '-c', 
+      opt :config,
+          "Configuration yaml file",
+          :short => '-c',
           :default => DEFAULT_CONFIG
 
-      opt :level, 
-          "Output level = (debug|info|warn|error|fatal)", 
-          :short => '-l', 
+      opt :pid_file,
+          "PID file path, used when daemonizing",
+          :short => '-p',
+          :default => HOME + "breaktime.pid"
+
+      opt :log_file,
+          "Log file path",
+          :short => '-l',
+          :default => HOME + "breaktime.log"
+
+      opt :level,
+          "Output level = (debug|info|warn|error|fatal)",
+          :short => '-o',
           :default => 'info'
 
     end

data/lib/breaktime/dialog.rb

@@ -13,11 +13,6 @@ module Breaktime
     background white
     flow :margin => 4 do
       @sent = para str % seconds
-
-      button "Cancel" do
-        exit Breaktime::EX_BREAK_CANCELLED
-      end
-
       every 1 do |i|
         if i >= seconds
           exit Breaktime::EX_OK
@@ -26,5 +21,15 @@ module Breaktime
         end
       end
     end
+    flow do
+      button "Cancel" do
+        exit Breaktime::EX_BREAK_CANCELLED
+      end
+
+      button "Gimme 5", :align => :right do
+        exit Breaktime::EX_BREAK_DELAYED
+      end
+    end
+
   end
 end

data/lib/breaktime/main.rb

@@ -12,8 +12,6 @@ class Breaktime::Main
 
   # Default options that can be overridden in the YAML file.
   DEFAULT_OPTIONS = {'interval' => 60,
-                     'pid_path' => ENV['HOME'] + File::SEPARATOR + "breaktime.pid",
-                     'log_path' => ENV['HOME'] + File::SEPARATOR + "breaktime.log",
                      'daemonize' => true,
                      'days' => ['monday',
                                 'tuesday',
@@ -31,6 +29,9 @@ class Breaktime::Main
     set_log_level @cli.options[:level]
 
     parse_yaml_file
+
+    @options['log_path'] = @cli.options[:log_file]
+    @options['pid_path'] = @cli.options[:pid_file]
   end
 
   # Exit with a trollop message.
@@ -102,8 +103,8 @@ class Breaktime::Main
   #
   # Uses Dante for daemonizing.
   def startd
-    dante_opts = {:daemonize => @options['daemonize'], 
-                  :pid_path => @options['pid_path'], 
+    dante_opts = {:daemonize => @options['daemonize'],
+                  :pid_path => @options['pid_path'],
                   :log_path => @options['log_path']}
 
     if dante_opts[:daemonize]
@@ -133,7 +134,7 @@ class Breaktime::Main
     # Create a new Main object and run the mode given as a CLI parameter.
     #
     # Also rescue exceptions and display helpful messages.
-    # 
+    #
     # TODO: tidy this up
     def start
       main = self.new

data/lib/breaktime/schedule.rb

@@ -57,10 +57,14 @@ class Breaktime::Schedule
       else
         @log.error { "Failed to run breaktime with the `now` mode" }
       end
+    when Breaktime::EX_BREAK_DELAYED
+      @log.info { "Delaying break by 5 minutes" }
+      sleep(300)
+      run_dialog
     when Breaktime::EX_BREAK_CANCELLED
       @log.warn { "Cancelled screen break" }
     else
-      @log.error { "Failed to run breaktime with the `dialog` mode" }
+      @log.error { "Failed to run breaktime with the `dialog` mode: return code #{retcode_d}" }
     end
   end
 
@@ -68,16 +72,12 @@ class Breaktime::Schedule
   #
   # The exit code is returned.
   def exec_self(mode, args = {})
-    arg_str = ''
-    @cli_options.merge(args).each do |n,v|
-      if v && !n.to_s.include?("_given")
-        arg_str += " --#{n} #{v}"
-      end
-    end
+    opts = @cli_options.merge(args)
+    arg_str = "--config #{opts[:config]} --level #{opts[:level]}"
     exec_str = "#{$PROGRAM_NAME} #{mode} #{arg_str}"
     @log.debug { "Executing `#{exec_str}`" }
     system exec_str
-    $?
+    $?.exitstatus
   end
 
 

data/lib/breaktime/version.rb

@@ -1,3 +1,3 @@
 module Breaktime
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breaktime
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: green_shoes