rbtclk 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f856f46825997cd5eb17503537fa07efaacf3587
-  data.tar.gz: 6fae1cb2024b28adf1cdf39e9f5091a77253007d
+  metadata.gz: 36989cdcf0479af2abae38d31b549887c9458794
+  data.tar.gz: 1c9439e5978b46deb1803ea01fe47210116d2505
 SHA512:
-  metadata.gz: 49dcec2a49152a56cad842e01a8984b3c07ff3d13a1445b39bb8c3a8a0d4c99c7c04509df46165f1b235d962db009376b63a349807acd4e7a92ea79e9c738867
-  data.tar.gz: fd70404e4be93060457f7427f456210ba037b7689d56fcdff7c68c765c2d3c568b49e86686d40f48dbaa9c2bedefa2c13a6e3b813af5157678aec3417acaaea3
+  metadata.gz: 93b1399d2fae3bb8e757145d7a0648f42f2ec8d645dbf9d88c6f7c001458368c96a4ef815e4bf4914d3fc0628e2e9a2f500f9647786af85334276c26716fff04
+  data.tar.gz: e0d5e06c5eff70e2a69e51f06ca91b73181390bf67ae4050de09bd047fcac42be490e6d52425ed1d6e625eedc9003b5908bace4bebed01bdfeebfba4678e870a

data/README.md

@@ -2,6 +2,8 @@
 
 A light-weight timer application that can run in terminal emulators :rabbit:
 
+![screenshot](https://raw.github.com/wiki/mozamimy/rbtclk/images/screenshot.gif)
+
 ## Requirement
 
 - Ruby 2.0 or later.
@@ -135,6 +137,18 @@ $ rbtclk --format "* %H:%M *"
   #   #               ##     ####      ##      ####      ####             #   #
 ```
 
+### Enable color
+
+Rbtclk can show clock with ANSI colors.  
+Black(default), red, green, yellow, blue, magenta, cyan and white are available.
+
+#### Example
+
+```shell
+$ rbtclk -c magenta
+$ rbtclk --color magenta
+```
+
 ## Progress Report
 
 - [x] Clock

data/lib/rbtclk.rb

@@ -1,4 +1,3 @@
-require "curses"
 require "optparse"
 require "rbtclk/version"
 require "rbtclk/clock"
@@ -13,16 +12,31 @@ module Rbtclk
         opt.on("--mode MODE") { |m| params[:mode] = m }
         opt.on("--format FORMAT") { |f| params[:format] = f }
         opt.on("--font FONT") { |f| params[:font] = f }
+        opt.on("--version") { |v| params[:version] = v }
+        opt.on("--color COLOR") { |c| params[:color] = c }
 
         opt.parse!(args)
       end
 
-      case params[:mode] || "clock"
+      if params[:version]
+        puts Rbtclk::VERSION
+        exit
+      else
+        display_clock(params)
+      end
+    end
+
+    def display_clock(params)
+      params = fill(params)
+
+      case params[:mode]
       when "clock"
-        timer = Clock.new(font: params[:font] || "clb8x8", format: params[:format] || "%X")
+        remove_extra_params(params)
+        timer = Clock.new(params)
         timer.show
       when "countup"
-        timer = CountupTimer.new(font: params[:font] || "clb8x8", format: params[:format] || "%X")
+        remove_extra_params(params)
+        timer = CountupTimer.new(params)
         timer.show
       else
         warn "#{params[:mode]} mode is not supported."
@@ -30,5 +44,16 @@ module Rbtclk
         exit(1)
       end
     end
+
+    def fill(params)
+      {mode: params[:mode] || "clock",
+       font: params[:font] || "clb8x8",
+       format: params[:format] || "%X",
+       color: params[:color] || "black"}
+    end
+
+    def remove_extra_params(params)
+      params.delete(:mode)
+    end
   end
 end

data/lib/rbtclk/clock.rb

@@ -1,15 +1,22 @@
 require "artii"
 require "curses"
+require "rbtclk/color_code"
 
 module Rbtclk
   class Clock
-    def initialize(font: "clb8x8", format: "%X")
+    include ColorCode
+
+    def initialize(font: "clb8x8", format: "%X", color: "black")
       @artii = Artii::Base.new(font: font)
       @format = format
+      @color = color
     end
 
     def show
       Curses.init_screen
+      Curses.start_color
+      Curses.use_default_colors
+      Curses.init_pair(1, translate(@color), -1)
       Curses.curs_set(0)
 
       begin
@@ -41,6 +48,7 @@ module Rbtclk
     def refresh
       Curses.clear
       Curses.setpos(0, 0)
+      Curses.attron(Curses.color_pair(1))
       Curses.addstr(@artii.asciify(Time.now.strftime(@format)))
       Curses.refresh
     end

data/lib/rbtclk/color_code.rb

@@ -0,0 +1,10 @@
+require "curses"
+
+module Rbtclk
+  module ColorCode
+    def translate(color_name)
+      color_name = color_name.to_s
+      Curses.const_get("COLOR_#{color_name.upcase}")
+    end
+  end
+end

data/lib/rbtclk/countup_timer.rb

@@ -1,17 +1,25 @@
 require "artii"
 require "curses"
 require "time"
+require "rbtclk/color_code"
 
 module Rbtclk
   class CountupTimer
-    def initialize(font: "clb8x8", format: "%X")
-      @artii = Artii::Base.new(font: font, format: "%X")
+    include ColorCode
+
+    def initialize(font: "clb8x8", format: "%X", color: "black")
+      @artii = Artii::Base.new(font: font)
       @format = format
+      @color = color
     end
 
     def show
       Curses.init_screen
+      Curses.start_color
+      Curses.use_default_colors
+      Curses.init_pair(1, translate(@color), -1)
       Curses.curs_set(0)
+
       @start_time = Time.now
 
       begin
@@ -26,7 +34,8 @@ module Rbtclk
           loop do
             case Curses.getch
             when "q"
-              exit
+              Thread.kill(view_thread)
+              Thread.kill(input_thread)
             end
           end
         end
@@ -42,6 +51,7 @@ module Rbtclk
     def refresh
       Curses.clear
       Curses.setpos(0, 0)
+      Curses.attron(Curses.color_pair(1))
       Curses.addstr(@artii.asciify((Time.parse("1/1") + (Time.now - @start_time)).strftime(@format)))
       Curses.refresh
     end

data/lib/rbtclk/version.rb

@@ -1,3 +1,3 @@
 module Rbtclk
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/rbtclk/color_code_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+require "curses"
+
+RSpec.describe Rbtclk::ColorCode do
+  include Rbtclk::ColorCode
+
+  describe "#translate" do
+    context "the argument is string" do
+      subject { translate("magenta") }
+      it { expect(subject).to eq Curses::COLOR_MAGENTA }
+    end
+
+    context "the argument is symbol" do
+      subject { translate(:magenta) }
+      it { expect(subject).to eq Curses::COLOR_MAGENTA }
+    end
+  end
+end

data/spec/rbtclk_spec.rb

@@ -1,5 +1,52 @@
 require 'spec_helper'
 
 RSpec.describe Rbtclk do
-  pending "Write later."
+  describe "#run" do
+    pending "this is pending bcause on the issue#3 (https://github.com/mozamimy/rbtclk/issues/3)"
+  end
+
+  describe "#display_clock" do
+    pending "this is pending bcause on the issue#3 (https://github.com/mozamimy/rbtclk/issues/3)"
+  end
+
+  describe "methods related with params" do
+    let(:filled_params) do
+      {mode: "clock",
+       font: "clb8x8",
+       format: "%X",
+       color: "black"}
+    end
+
+    describe "#fill" do
+      context "there are no blank elements in the argument" do
+        subject { Rbtclk.fill(filled_params) }
+        it { expect(subject).to eq filled_params }
+      end
+
+      context "there in a blank element in the argument" do
+        let(:not_filled_params) do
+          {mode: "clock",
+           font: "clb8x8",
+           format: "%X"}
+        end
+
+        subject { Rbtclk.fill(not_filled_params) }
+        it { expect(subject).to eq filled_params }
+      end
+    end
+
+    describe "#remove_extra_params" do
+      let(:params_that_has_no_mode) do
+        filled_params.delete(:mode)
+        filled_params
+      end
+
+      context "params contains :mode value" do
+        specify ":mode value is removed" do
+          Rbtclk.remove_extra_params(filled_params)
+          expect(filled_params).to eq params_that_has_no_mode
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbtclk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Moza USANE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,9 +126,11 @@ files:
 - bin/rbtclk
 - lib/rbtclk.rb
 - lib/rbtclk/clock.rb
+- lib/rbtclk/color_code.rb
 - lib/rbtclk/countup_timer.rb
 - lib/rbtclk/version.rb
 - rbtclk.gemspec
+- spec/rbtclk/color_code_spec.rb
 - spec/rbtclk_spec.rb
 - spec/spec_helper.rb
 homepage: http://quellencode.org/
@@ -156,5 +158,6 @@ signing_key:
 specification_version: 4
 summary: A light-weight timer application that can run in terminal emulators.
 test_files:
+- spec/rbtclk/color_code_spec.rb
 - spec/rbtclk_spec.rb
 - spec/spec_helper.rb