eyecare 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28fe112827d32de770483d3b5eaf9636b18c8ee6
-  data.tar.gz: 744a0290be6f3433f9df56f3fb25fac29af2812d
+  metadata.gz: 8e004ee89fa1ccdaedc3c380870abda32967566f
+  data.tar.gz: 7657db390db6a9d5784df05d69147aee23bf1218
 SHA512:
-  metadata.gz: 5306596df896dc1155036bc56a26e9e6ce36f5e5e17fcca1940614dd7b58ff747a7f71fcdd85e71aad34c8dd5a57c3c109d8b8a86866e102d8a936ff4f6281d8
-  data.tar.gz: 1aa7b04e93905f680e4ffff061a11d709a193a40a837a0b50ba4fc95371f6ddf46e68e5f3ad4b60aee672b76d1e157523291f1912a152bc9f764ac54a068cd1f
+  metadata.gz: 861bec7f2f2fdabdfc16109f3c9d12df652bea2b8214b485ffe306e2112b9bf4eed60c3a80dd36c4e9109111daf0055ef51550e4fa7ec6b30770b5bd066ab4b0
+  data.tar.gz: 72ed5653993ecb3e8183213f7f9ff7db3280f5743fa1effbab148fd6b52d0a3824a1d0a9278fb817d11defc1675c2299042d048a27aec8e6809799a34c3a7d22

data/README.md

@@ -2,7 +2,6 @@
 
 Reminds you to look away to avoid computer eye strain.
 It is recommended to look away from your screen for 20 seconds every 20 minutes.
-This might only work on Ubuntu!
 
 ## Installation
 

data/eyecare.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ffi'
   spec.add_dependency 'libnotify'
   spec.add_dependency 'chronic_duration'
+  spec.add_dependency 'activesupport', '~> 4'
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'

data/lib/eyecare.rb

@@ -6,6 +6,22 @@ require 'eyecare/daemon'
 require 'fileutils'
 require 'ffi'
 
+class Hash
+  def deep_compact
+    dup.deep_compact!
+  end
+
+  def deep_compact!
+    each do |key, value|
+      if value.respond_to?(:deep_compact)
+        value = value.deep_compact
+        value = nil if value.length == 0
+      end
+      self[key] = value
+    end.compact
+  end
+end
+
 module Eyecare
   extend FFI::Library
   ffi_lib FFI::Library::LIBC
@@ -22,7 +38,7 @@ module Eyecare
     attr_reader :config_path
 
     def run
-      Daemon.start(config[:pid_file]) do 
+      Daemon.start(config[:pid_file]) do
         while true
           seconds = config[:alert][:interval]
           while seconds > 0
@@ -47,14 +63,19 @@ module Eyecare
       return @config if @config
 
       config_file = File.expand_path(config_path)
-      @config = Config.load_from_file(config_file) rescue Config.new
+
+      if File.exists?(config_file) && File.file?(config_file) && File.readable?(config_file)
+        @config = Config.load_from_file(config_file)
+      end
+
+      @config ||= Config.new
     end
 
     private
     def proc_name(name)
       $0 = name
       return false unless self.respond_to?(:prctl)
-   
+
       name = name.slice(0, 16)
       ptr = FFI::MemoryPointer.from_string(name)
       self.prctl(15, ptr.address, 0, 0)

data/lib/eyecare/alert.rb

@@ -10,19 +10,22 @@ module Eyecare
     attr_accessor :beep
     attr_accessor :icon_path
 
-    DEFAULT_MESSAGE = Config::DEFAULTS[:alert][:message]
-    DEFAULT_TIMEOUT = Config::DEFAULTS[:alert][:timeout]
-    DEFAULT_BEEP_START = File.join(Config::AUDIOS_PATH, 'beep_start.wav')
-    DEFAULT_BEEP_END = File.join(Config::AUDIOS_PATH, 'beep_end.wav')
-    DEFAULT_ICON_PATH = Config::DEFAULTS[:alert][:icon]
+    DEFAULT_MESSAGE     = Config::DEFAULTS[:alert][:message]
+    DEFAULT_TIMEOUT     = Config::DEFAULTS[:alert][:timeout]
+    DEFAULT_BEEP_START  = Config::DEFAULTS[:alert][:beep][:start]
+    DEFAULT_BEEP_END    = Config::DEFAULTS[:alert][:beep][:end]
+    DEFAULT_BEEP_PLAYER = Config::DEFAULTS[:alert][:beep][:player]
+    DEFAULT_ICON_PATH   = Config::DEFAULTS[:alert][:icon]
 
     class Beep
       attr_accessor :start
       attr_accessor :end
+      attr_accessor :player
 
       def initialize(options = {})
-        @start = Eyecare::Audio.new(options[:start])
-        @end = Eyecare::Audio.new(options[:end])
+        @player = options[:player]
+        @start = Eyecare::Audio.new(options[:start], options[:player])
+        @end = Eyecare::Audio.new(options[:end], options[:player])
       end
 
       def play(name)
@@ -37,12 +40,14 @@ module Eyecare
 
       beep_start = DEFAULT_BEEP_START
       beep_end = DEFAULT_BEEP_END
+      beep_player = DEFAULT_BEEP_PLAYER
       if options[:beep]
         beep_start = options[:beep][:start] if options[:beep][:start]
         beep_end = options[:beep][:end] if options[:beep][:end]
+        beep_player = options[:beep][:player] if options[:beep][:player]
       end
 
-      @beep = Beep.new(start: beep_start, end: beep_end)
+      @beep = Beep.new(start: beep_start, end: beep_end, player: beep_player)
       self
     end
 

data/lib/eyecare/audio.rb

@@ -1,13 +1,29 @@
 module Eyecare
   class Audio
     attr_accessor :filename
-    def initialize(filename)
+    attr_accessor :player
+
+    DEFAULT_PLAYER = 'aplay :file'
+
+    def initialize(filename, player = nil)
       @filename = filename
+      @player = player ? player : DEFAULT_PLAYER
     end
 
     def play
-      pid = spawn("aplay #{filename} > /dev/null 2>&1")
+      return unless player
+      pid = spawn(player_cmd + ' > /dev/null 2>&1')
       Process.detach(pid)
     end
+
+    private
+    def player_cmd
+      return @player_cmd if @player_cmd
+      @player_cmd = @player ? @player : DEFAULT_PLAYER
+      @player_cmd = @player_cmd.gsub(/:filename/, ':file')
+        .gsub(/:filepath/, ':file')
+        .gsub(/:file_path/, ':file')
+        .gsub(/:file/, filename)
+    end
   end
 end

data/lib/eyecare/config.rb

@@ -1,18 +1,12 @@
 require 'yaml'
 require 'chronic_duration'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/compact'
+require 'active_support/core_ext/hash/deep_merge'
 require 'eyecare'
 
-module Eyecare
-
-  class ::Hash
-    def symbolize_keys
-      self.inject({}) do |h, (k, v)|
-        v = v.symbolize_keys if v.respond_to?(:symbolize_keys)
-        h.merge({ k.to_sym => v })
-      end
-    end
-  end
 
+module Eyecare
   class Config
     ASSETS_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'assets'))
     IMAGES_PATH = File.join(ASSETS_PATH, 'images')
@@ -25,6 +19,7 @@ module Eyecare
         interval: 20 * 60,
         icon: File.join(IMAGES_PATH, 'eyecare.png'),
         beep: {
+          player: "aplay :file",
           start: File.join(AUDIOS_PATH, 'beep_start.wav'),
           end: File.join(AUDIOS_PATH, 'beep_end.wav')
         }
@@ -33,12 +28,14 @@ module Eyecare
       pid_file: File.expand_path(File.join('.eyecare', 'eyecare.pid'), '~')
     }
 
+    attr_reader :options
+
     def initialize(options = {})
       @options = DEFAULTS
-      if options.respond_to?(:symbolize_keys)
-        options = options.symbolize_keys
+      if options.respond_to?(:deep_symbolize_keys)
+        options = options.deep_symbolize_keys.deep_compact
         options = parse_duration_values(options)
-        @options.merge!(options)
+        @options = @options.deep_merge(options)
       end
     end
 
@@ -59,8 +56,11 @@ module Eyecare
       return options unless options.is_a?(Hash)
       if options[:alert].is_a?(Hash)
         [:interval, :timeout].each do |k|
-          options[:alert][k] = ChronicDuration.parse(options[:alert][k]) if options[:alert][k].is_a?(String)
-          options[:alert][k] = options[:alert][k].to_i
+          if options[:alert][k]
+            options[:alert][k] = ChronicDuration.parse(options[:alert][k]) if options[:alert][k].is_a?(String)
+            options[:alert][k] = options[:alert][k].to_i
+            options[:alert].delete(k) if options[:alert][k] == 0
+          end
         end
       end
       options

data/lib/eyecare/version.rb

@@ -1,3 +1,3 @@
 module Eyecare
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/alert_test.rb

@@ -3,10 +3,13 @@ require 'eyecare/alert'
 
 describe Eyecare::Alert do
   let(:config) do
-    { 
+    {
       message: 'Blink blink',
       timeout: 40,
-      interval: 1800
+      interval: 1800,
+      beep: {
+        player: 'fooplayer :file'
+      }
     }
   end
 
@@ -15,6 +18,7 @@ describe Eyecare::Alert do
     alert.message.wont_be_empty
     alert.message.must_equal Eyecare::Alert::DEFAULT_MESSAGE
     alert.timeout.must_equal Eyecare::Alert::DEFAULT_TIMEOUT
+    alert.beep.player.must_equal Eyecare::Alert::DEFAULT_BEEP_PLAYER
   end
 
   it 'correctly initialized from config hash' do
@@ -23,5 +27,6 @@ describe Eyecare::Alert do
     alert.message.wont_be_empty
     alert.message.must_equal config[:message]
     alert.timeout.must_equal config[:timeout]
+    alert.beep.player.must_equal config[:beep][:player]
   end
 end

data/test/audio_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+require 'eyecare/audio'
+
+describe Eyecare::Alert do
+  it "player command is always valid" do
+    audio = Eyecare::Audio.new('foo.wav', 'fooplayer :file')
+    player_cmd = audio.send(:player_cmd)
+    player_cmd.must_equal 'fooplayer foo.wav'
+
+    audio = Eyecare::Audio.new('foo.wav', 'fooplayer :filename')
+    player_cmd = audio.send(:player_cmd)
+    player_cmd.must_equal 'fooplayer foo.wav'
+  end
+end

data/test/config_test.rb

@@ -55,8 +55,8 @@ describe Eyecare::Config do
     %"
       alert:
         message: 'This is a test message'
-        timeout: 
-        interval: 
+        timeout:
+        interval:
         beep:
           start: /path/to/beep/start.wav
           end: /path/to/beep/end.wav
@@ -81,8 +81,8 @@ describe Eyecare::Config do
   end
 
   it 'is malformed' do
-    config = Eyecare::Config.load_from_text('fdaf-fff:fsdafd')
-    assert_default(config) 
+    config = Eyecare::Config.load_from_text(YAML.load('fdaf-fff:fsdafd'))
+    assert_default(config)
   end
 
   it 'is loaded from file' do
@@ -90,7 +90,7 @@ describe Eyecare::Config do
     f = Tempfile.new('config')
     f.write(config_text)
     f.close
-  
+
     config = Eyecare::Config.load_from_file(f.path)
     f.unlink
     config[:alert][:message].wont_be_empty

data/test/eyecare_test.rb

@@ -4,7 +4,12 @@ require 'tempfile'
 describe Eyecare do
   describe 'config' do
     it 'is default if config file is missing' do
-      config = Eyecare.config
+      stub = Eyecare.dup
+      stub.instance_eval do
+        @config_path = ''
+      end
+
+      config = stub.config
       config[:alert][:message].wont_be_empty
       config[:alert][:message].must_equal Eyecare::Config::DEFAULTS[:alert][:message]
       config[:alert][:timeout].must_equal Eyecare::Config::DEFAULTS[:alert][:timeout]
@@ -14,7 +19,7 @@ describe Eyecare do
 
     it 'is loaded from file if file exists' do
       config_yml = %"
-        alert: 
+        alert:
           message: 'Yadayada'
           timeout: 10
           interval: 1000
@@ -24,13 +29,13 @@ describe Eyecare do
       config_file.write(config_yml)
       config_file.close
 
-      EyecareStub = Eyecare.dup
-      EyecareStub.instance_eval do
+      stub = Eyecare.dup
+      stub.instance_eval do
         @config = nil
         @config_path = config_file.path
       end
 
-      config = EyecareStub.config
+      config = stub.config
 
       config[:alert][:message].wont_be_empty
       config[:alert][:message].must_equal 'Yadayada'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyecare
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Viorel Craescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-19 00:00:00.000000000 Z
+date: 2015-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,7 @@ files:
 - lib/eyecare/daemon.rb
 - lib/eyecare/version.rb
 - test/alert_test.rb
+- test/audio_test.rb
 - test/config_test.rb
 - test/eyecare_test.rb
 - test/test_helper.rb
@@ -143,12 +158,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Protect your eyes
 test_files:
 - test/alert_test.rb
+- test/audio_test.rb
 - test/config_test.rb
 - test/eyecare_test.rb
 - test/test_helper.rb