rbtclk 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0fc07db46af23f24380a963fa37722a3ff6bb7a
-  data.tar.gz: eebf1b0c316d18cdd75d26feae2043491858178e
+  metadata.gz: 249cb25def3f52ad44433d4f871f72cbd75cf7a3
+  data.tar.gz: c547d281e2e035742cae671576296f0d34532b21
 SHA512:
-  metadata.gz: bba36b861bb79b97bb5e022e7b4401c191a9bb63a7af1f8037e2be552aa143141f7c93c93ad6e8cc6c41aff224298aa17c94bd24db67f09dbfb9d3fbf13ae6e9
-  data.tar.gz: a4eccd625012d44a89b8f6f0f94dd0d6c515338cced9da1e1ca6e5904217f6ea20190fd1363bdda4b0b059689fc2746fb7630c08e42ab8b99e1ba601ea30f434
+  metadata.gz: db87de5f550c2e183fed77957ee96e2d424fae85045df107ff0b3499ca1f946d156285b9cc75d31d6cf8c487c8981bb74ad90d1cc19e5f5237fc966eac417fc6
+  data.tar.gz: 5670e0ad318bb2579747af6df0ea412772a39a23b2a2371c25b4b1f8f85cc02dfed857035edff072bd6c44324bfb6665f48f2826028479dce6439fad93a0bf4c

data/README.md

@@ -7,6 +7,21 @@ A light-weight timer application that can run in terminal emulators :rabbit:
 ## Requirement
 
 - Ruby 2.0 or later.
+- afplay or mpg123
+
+This application is tested on OS X 10.10 and Arch Linux.
+
+Rbtclk needs a sound player tool like afplay or mpg123.  
+OS X has normally afplay as default.  
+If you use other UNIX like system, you should install mpg123.
+
+On Arch Linux,
+
+```shell
+$ sudo pacman -S mpg123
+```
+
+Rbtclk works without sound player tools, but alerming by sound file is disabled.
 
 ## Installation
 
@@ -34,7 +49,7 @@ $ rbtclk
 
 ### Mode
 
-This application supports some modes; clock, countup and countdown.
+This application supports some modes; clock, countup and countdown.  
 
 #### Example
 
@@ -83,10 +98,14 @@ $ rbtclk -m countdown --time 90
   ####     ####      ##      ####       ##      ##      ####     ####
 ```
 
+When remaining time reaches 0, rbtclk produces a sound to alert.  
+This function is experimental!  
+You can use this feature on only OS X.
+
 ### Change font
 
 This application depends on artii library (https://github.com/miketierney/artii).  
-You can use any fonts that are supported by artii.
+You can use any fonts are supported by artii.
 
 #### Example
 
@@ -187,6 +206,9 @@ Rbtclk.configure do |c|
 
   # You can specify limit time as seconds in countdown timer.
   c.time = "180"
+
+  # The alarm sound is suppressed if no_alarm is true.
+  c.no_alarm = false
 end
 ```
 
@@ -196,7 +218,9 @@ end
 - [x] Countup Timer
 - [x] Countdown Timer
 - [x] Configuration by ~/.rbtclk
-- [ ] Sound
+- [x] Sound
+- [ ] Sound on Linux/BSD
+- [ ] Controlling sound by command line options
 - [ ] Refactoring
 
 ## Code Status
@@ -210,3 +234,7 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Special Thanks!
+Alert sound is distributed by [Taira Komori](http://taira-komori.jpn.org/freesounden.html).
+Thanks!

data/config/default.rb

@@ -21,4 +21,7 @@ Rbtclk.configure do |c|
 
   # You can specify limit time as seconds in countdown timer.
   c.time = "180"
+
+  # The alarm sound is suppressed if no_alarm is true.
+  c.no_alarm = false
 end

data/lib/rbtclk.rb

@@ -24,6 +24,7 @@ module Rbtclk
         opt.on("--version") { |v| params[:version] = v }
         opt.on("--color COLOR") { |c| params[:color] = c }
         opt.on("--time TIME") { |t| params[:time] = t }
+        opt.on("--noalarm") { |n| params[:no_alarm] = n }
 
         opt.parse!(args)
       end
@@ -63,15 +64,17 @@ module Rbtclk
        font: params[:font] || FONT,
        format: params[:format] || FORMAT,
        color: params[:color] || COLOR,
-       time: params[:time] || TIME}
+       time: params[:time] || TIME,
+       no_alarm: params[:no_alarm] || NO_ALARM}
     end
 
     def remove_extra_params(params)
-      params.delete(:mode)
-
       if params[:mode] != "countdown"
         params.delete(:time)
+        params.delete(:no_alarm)
       end
+
+      params.delete(:mode)
     end
   end
 

data/lib/rbtclk/config_loader.rb

@@ -10,11 +10,8 @@ module Rbtclk
     def load_config
       dot_rbtclk_in_home = File.expand_path(".rbtclk", "~")
 
-      if File.exist?(dot_rbtclk_in_home)
-        load dot_rbtclk_in_home
-      else
-        load File.expand_path("../../../config/default.rb", __FILE__)
-      end
+      load File.expand_path("../../../config/default.rb", __FILE__)
+      load dot_rbtclk_in_home if File.exist?(dot_rbtclk_in_home)
     end
 
     # Methods for configuration DSL
@@ -22,9 +19,12 @@ module Rbtclk
       self.instance_eval(&block)
     end
 
-    %w(mode font format color time).each do |attr|
+    %w(mode font format color time no_alarm).each do |attr|
       define_method "#{attr}=" do |value|
-        const_set attr.to_s.upcase, value
+        const_name = attr.to_s.upcase
+
+        remove_const const_name if const_defined?(const_name)
+        const_set const_name, value
       end
     end
   end

data/lib/rbtclk/countdown_timer.rb

@@ -6,17 +6,20 @@
 require "artii"
 require "curses"
 require "rbtclk/color_code"
+require "rbtclk/sound_player"
 
 module Rbtclk
   class CountdownTimer
     include ColorCode
 
-    def initialize(font: "clb8x8", format: "%X", color: "black", time: 180)
+    def initialize(font: "clb8x8", format: "%X", color: "black", time: 180, no_alarm: false)
       @artii = Artii::Base.new(font: font)
       @format = format
       @color = color
       @time = time.to_i
+      @no_alarm = no_alarm
       @elapsed = 0
+      @sound_player = SoundPlayer.new
     end
 
     def show
@@ -37,10 +40,12 @@ module Rbtclk
             sleep 1
           end
 
+          @sound_player.play unless @no_alarm
+
           toggle_marker = true
           loop do
             blink(toggle_marker)
-            is_even = !is_even
+            toggle_marker = !toggle_marker
             sleep 1
           end
         end

data/lib/rbtclk/sound_player.rb

@@ -0,0 +1,32 @@
+# Rbtclk
+# Copyright (c) 2014 Moza USANE
+# This software is released under the MIT License.
+# http://opensource.org/licenses/mit-license.php
+
+require "open3"
+
+module Rbtclk
+  class SoundPlayer
+    def initialize
+      sound_file_path = File.expand_path("../../../sound/bell.mp3", __FILE__)
+
+      @command_line = if command_exist?("afplay")
+                        "afplay #{sound_file_path}"
+                      elsif command_exist?("mpg123")
+                        "mpg123 -q #{sound_file_path}"
+                      else
+                        ":" # do noghing
+                      end
+    end
+
+    def play
+      spawn @command_line
+    end
+
+    private
+
+    def command_exist?(command)
+      Open3.capture3("which #{command}")[2].success?
+    end
+  end
+end

data/lib/rbtclk/version.rb

@@ -4,5 +4,5 @@
 # http://opensource.org/licenses/mit-license.php
 
 module Rbtclk
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/spec/rbtclk/config_loader_spec.rb

@@ -19,6 +19,7 @@ RSpec.describe Rbtclk::ConfigLoader do
         c.format = "cheshire-cat"
         c.color = "queen-of-hearts"
         c.time = "march-hare"
+        c.no_alarm = true
       end
     end
 
@@ -27,6 +28,7 @@ RSpec.describe Rbtclk::ConfigLoader do
     it { expect(target_klass::FORMAT).to eq "cheshire-cat" }
     it { expect(target_klass::COLOR).to eq "queen-of-hearts" }
     it { expect(target_klass::TIME).to eq "march-hare" }
+    it { expect(target_klass::NO_ALARM).to eq true }
   end
 
   describe ".mode" do
@@ -53,4 +55,9 @@ RSpec.describe Rbtclk::ConfigLoader do
     before { target_klass.time = "march-hare" }
     it { expect(target_klass::TIME).to eq "march-hare" }
   end
+
+  describe ".no_alarm" do
+    before { target_klass.no_alarm = true }
+    it { expect(target_klass::NO_ALARM).to eq true }
+  end
 end

data/spec/rbtclk_spec.rb

@@ -28,7 +28,8 @@ RSpec.describe Rbtclk do
        font: "clb8x8",
        format: "%X",
        color: "black",
-       time: "180"}
+       time: "180",
+       no_alarm: false}
     end
 
     before do
@@ -60,31 +61,35 @@ RSpec.describe Rbtclk do
     describe "#remove_extra_params" do
       context "params contains :mode value" do
         let(:params_that_has_no_mode) do
-          filled_params.delete(:mode)
-          filled_params
+          dup_params = filled_params.dup
+          dup_params.delete(:mode)
+          dup_params
         end
 
-        let(:params_that_has_no_mode_and_no_time) do
-          params_that_has_no_mode.delete(:time)
-          params_that_has_no_mode
+        let(:params_that_has_no_mode_and_no_time_and_no_alarm) do
+          dup_params = params_that_has_no_mode.dup
+          dup_params.delete(:time)
+          dup_params.delete(:no_alarm)
+          dup_params
         end
 
         context "mode is clock" do
           specify ":mode and :time values are removed" do
             Rbtclk.remove_extra_params(filled_params)
-            expect(filled_params).to eq params_that_has_no_mode_and_no_time
+            expect(filled_params).to eql params_that_has_no_mode_and_no_time_and_no_alarm
           end
         end
 
         context "mode is countdown" do
           let(:filled_params_whose_mode_is_clock) do
-            filled_params[:mode] = "countdown"
-            filled_params
+            dup_params = filled_params.dup
+            dup_params[:mode] = "countdown"
+            dup_params
           end
 
           specify ":mode and :time values are removed" do
-            Rbtclk.remove_extra_params(filled_params)
-            expect(filled_params_whose_mode_is_clock).to eq params_that_has_no_mode
+            Rbtclk.remove_extra_params(filled_params_whose_mode_is_clock)
+            expect(filled_params_whose_mode_is_clock).to eql params_that_has_no_mode
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbtclk
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Moza USANE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,8 +131,10 @@ files:
 - lib/rbtclk/config_loader.rb
 - lib/rbtclk/countdown_timer.rb
 - lib/rbtclk/countup_timer.rb
+- lib/rbtclk/sound_player.rb
 - lib/rbtclk/version.rb
 - rbtclk.gemspec
+- sound/bell.mp3
 - spec/rbtclk/color_code_spec.rb
 - spec/rbtclk/config_loader_spec.rb
 - spec/rbtclk_spec.rb