clock_window 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5012765917a148b032d0ba2d0500799e4f755f3c
-  data.tar.gz: 4753ccc37be96da66166b90a683c2c08c3cad383
+  metadata.gz: 8f8d46cc95dbc15c89b1f5d1264c0075f31e3328
+  data.tar.gz: 5dfdbcd5c40742cbf87a4a706e6c30dc8990ad5c
 SHA512:
-  metadata.gz: d4794cfd6ebec829de70e8ef42a6c6901ffd3b2cbdcdbbc7669a22374fc075bcda2eb36e7e3d1dafb470ff117319e0487bdd650b3b432655e6a47015aed440ed
-  data.tar.gz: 615416ae0e711751cefed115c9848e090a919c8f3f40ea39c0896fa29973a6d4a95eabd1709a1d68b9ae2f1b7428683383a2948e2a93f9e8566acd8d439a4fcf
+  metadata.gz: b25057158d6bcfc9f1eeebff62792f3fe382a3e2fb607312ca35b51d3ccf6c0cbfd4c618bb1eddd94a119bf066c0fbfbe661206faa6c81457abd44abc6ad2b35
+  data.tar.gz: 80a431c88f389f5c0427d69f9d4a430a2e55fb4c1e68e2d351d3c5018f4950aeb73204ae38624f9fdc2323551f598f657b69b68112f893ce66ba51120dbe46e4

data/README.md

@@ -1,12 +1,18 @@
 [![Build Status](https://travis-ci.org/danielpclark/clock_window.svg?branch=master)](https://travis-ci.org/danielpclark/clock_window)
+[![Gem Version](https://badge.fury.io/rb/clock_window.svg)](https://badge.fury.io/rb/clock_window)
 [![Code Triagers Badge](http://www.codetriage.com/danielpclark/clock_window/badges/users.svg)](http://www.codetriage.com/danielpclark/clock_window)
 
 # Clock Window
-A minimalist script to keep track of how long each window is active.  Measured in quarter minutes.  Hash builds until you kill the script with CTRL-C at which point it writes out the log file.  This script <del>adds no extra CPU load</del> will not raise the CPUs temperature indicating minimal CPU usage.
+[![OS Support](https://github.com/danielpclark/clock_window/blob/master/assets/mac-lin.png)]()
 
-The output will look quite nice in any text editor aligned by the colon separator.
+**Mac** & **Linux** compatible.
+
+A minimalist script to keep track of how long each window is active.
+Measured in quarter minutes.  Hash builds until you kill the script with CTRL-C
+at which point it writes out the log file.  This script <del>adds no extra CPU load</del>
+will not raise the CPUs temperature indicating minimal CPU usage.
 
-**Linux** & **Mac** compatible.
+The output will look quite nice in any text editor aligned by the colon separator.
 
 Output looks like:
 ```
@@ -25,7 +31,29 @@ Output looks like:
 gem install clock_window
 ```
 
-To execute just run `clock_window` .  If you put this script in your executable path then the **timelog.json** file should appear in whatever folder you run it from.
+# Usage
+
+The `clock_window` script now accepts command line parameters.
+
+```
+usage: clock_window [options]
+
+    -c, --clean   Use all known name filters
+    -o, --output  File/directory output in strftime
+    -e, --eager   Use strftime of time at start of script
+
+    --version     Print the version
+    -h, --help    This help menu
+```
+
+And to save the file in a `year-month/day_of_year.json` format you can execute the script with.
+
+```
+clock_window -ceo "%Y-%m/%j.json"
+```
+
+For more customizable date formats see the [documentation for strftime](http://apidock.com/ruby/DateTime/strftime).
+Default file output name is `timelog.json`.
 
 # Contributing
 

data/clock_window.gemspec

@@ -13,12 +13,13 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Clock active window.  Time tracker by window name.}
   spec.homepage      = "https://github.com/danielpclark/clock_window"
   spec.license       = "MIT"
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "neatjson", "~> 0.8"
+  spec.add_dependency "slop", "~> 4.3"
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "minitest", "~> 5.8"

data/exe/clock_window

@@ -1,17 +1,57 @@
 #!/usr/bin/env ruby
 
+require 'fileutils'
+require 'slop'
 require 'neatjson'
 require 'clock_window'
+
+opts = Slop.parse do |o|
+  o.banner = <<-BANNER
+Clock Window - "Clock your desktop activity!"
+Copyright (c) 2016 Daniel P. Clark via the MIT License
+Version: #{ClockWindow::VERSION}
+
+usage: clock_window [options]
+BANNER
+  o.bool "-c", "--clean", "Use all known name filters"
+  o.string "-o", "--output", "File/directory output in strftime"
+  o.bool "-e", "--eager", "Use strftime of time at start of script\n"
+
+  o.on "--version", "Print the version" do
+    puts ClockWindow::VERSION
+    exit
+  end
+  o.bool "-h", "--help", "This help menu\n\n"
+end
+
+if opts[:help]
+  puts opts
+  exit
+else
+  puts opts.to_s.partition("\n\n").first
+  puts "\nPress CTRL-C to exit the script."
+  puts "Starting active window tracking!"
+end 
+
+dir_name, _, file_name = opts[:output].to_s.rpartition(File::SEPARATOR)
+file_name = "timelog.json" if file_name.empty?
+
+@time = Time.now if opts[:eager]
 @hash = {}
 begin
   loop do
-    x = ClockWindow::ClockIt.new.active_window
+    filter_opts = opts.clean? ? {filter_opts: {no_notify: true}} : {}
+    x = ClockWindow::ClockIt.new(**filter_opts).active_window
     @hash[x] = @hash[x].to_f + 0.25
     sleep 15
   end
 ensure
   @hash = {"*---------- WINDOW NAME ----------*" => "minutes"}.merge(@hash)
-  File.open("timelog.json","w") do |f|
+  @time ||= Time.now
+  dir = @time.strftime(dir_name)
+  FileUtils.mkdir_p(dir) unless dir.empty?
+  file = @time.strftime(file_name)
+  File.open("#{dir}#{File::SEPARATOR unless dir.empty?}#{file}","w") do |f|
     f.write(JSON.neat_generate(@hash,aligned:true,around_colon:1))
   end
 end

data/lib/clock_window/version.rb

@@ -1,3 +1,3 @@
 module ClockWindow
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clock_window
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement