termodoro 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7682de14275ca02cf30abbe59667d3da687c0efe
-  data.tar.gz: a70da49bae67f5e40bbf256d7037b47350e5d85e
+  metadata.gz: f1b179dbc003a27c93f537e8a32f92319bc3e936
+  data.tar.gz: 849572b7195a5c66f6ead2cdd10ad4ed729cd1b3
 SHA512:
-  metadata.gz: c4008f442898bffc655229d1f949d148ea4dcf0ccce288925c89925e0413d27fe4e30a4b4c115bd38dc40445f93028d77b36fcb7e4a5c171b88ed492dbc6d199
-  data.tar.gz: d83df704e3cd2fc09b335c16d69afbae37734392c96dbe91a7472298e0f39dae87defd28d878db263ea61e282b093ab5db2c649e3f5fbef313ca58c3eda9191d
+  metadata.gz: 3247afeda64d043008398073db375b3485618826ecc8d88594e02a1e3309e64bcf00ce1b9a66835d0f958fc30d01f8770896e5a816936ce543c30f8cb4482e74
+  data.tar.gz: 5b8014bdcb94f277f4a7facece051e3582b35e8931db0a1a95b7c1c478fa5690f4e73faabe1e57ff158a2e62f541856dc8b54de6a9e8de42d9d2da43d9335a0b

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+### 0.3.0 (10/30/2013)
+
+- Now with tests! - [@vcavallo](http://github.com/vcavallo)
+
 ### 0.2.6 (10/29/2013)
 
-- Fully-document using YARD. Updated variable names (`time_part` --> `time_unit`, `number_part` --> `number_of_units`). Minor readme updates.
+- Fully-document using YARD. Updated variable names (`time_part` --> `time_unit`, `number_part` --> `number_of_units`). Minor readme updates. - [@vcavallo](http://github.com/vcavallo)
 
 ### 0.2.5 (10/29/2013)
  

data/lib/termodoro/termodoro.rb

@@ -1,5 +1,4 @@
 
-
 # A new instance of this class takes user-input as command line arguments and 
 # prepares a string to be execute as a Bash system command. The user specifies an
 # amount of time and an optional message to display. After the amount of time elapses
@@ -7,6 +6,7 @@
 # the word "Termodoro" appears instead.
 class Termodoro
   attr_accessor :time_unit, :number_of_units, :message
+  attr_reader :arguments
   # @!attribute time_unit
   #   @return [String] the unit of time specified by the user.
   # @!attribute number_of_units
@@ -101,9 +101,9 @@ class Termodoro
   # PENDING - will eventually be used to ensure user input is safe to run as terminal
   # command. (i.e. remove special punctuation and the like).
   # @return [String] sanitized message.
-  def clean_message
-    parse_message
-  end
+  # def clean_message
+  #   parse_message
+  # end
 
   # Workhorse method: Runs #calculate_time and #parse_message, taking the results
   # of those methods and creating the string to execute.

data/license.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Vinney Cavallo
+Copyright (c) 2013 Vinney Cavallo and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/spec/spec_helper.rb

@@ -14,5 +14,5 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
+  # config.order = 'random'
 end

data/spec/termodoro_spec.rb

@@ -1,15 +1,98 @@
 require_relative 'spec_helper'
 
 describe "Termodoro" do
-  it "takes a well-formed time and message string" do
-    arg = "10 seconds do something"
-    term = Termodoro.new(arg)
-    term.command.should be_an_instance_of(String)
+  let(:input) {"10 minutes show this message"}
+  let(:term) {Termodoro.new(input)}
+
+  it "can be initialized" do 
+    expect(Termodoro.new("test")).to be_an_instance_of(Termodoro)
+  end
+
+  it "can accept user input" do
+    expect(term.arguments).to eq(input)
+  end
+
+  it "ends up with a well-formed string to be issued as a system command" do
+    expect(term.command).to be_an_instance_of(String)
+  end
+
+  describe "Constants" do
+    it "has a constant that represents number of seconds in a minute" do
+      expect(Termodoro::SECS_IN_MIN / 60).to eq(1)
+    end
+
+    it "has a constant that represents number of seconds in an hour" do
+      expect(Termodoro::SECS_IN_HOUR / 3600).to eq(1)
+    end
+  end
+
+  describe "Methods on user input" do
+
+    it "can parse and retreive the decimal provided" do
+      expect(term.parse_number_of_units).to eq(10)
+    end 
+
+    it "can parse and retreive the unti of time provided" do
+      expect(term.parse_time_unit).to eq("minutes")
+    end
+
+    it "can parse and retreive the message provided" do
+      expect(term.parse_message).to eq("show this message")
+    end
+
+    it "allows the message to be optional" do
+      no_message_arg = "10 seconds"
+      term_alt = Termodoro.new(no_message_arg)
+      expect(term_alt.command).to be_an_instance_of(String)
+    end
+
+    describe "Flexibility on wording of unit of time" do
+      it "will accept partial matches of 'seconds' (i.e. s sec secs second seconds)" do
+        weird_seconds = "10 s"
+        term_alt = Termodoro.new(weird_seconds)
+        expect(term_alt.calculate_time).to eq(10)
+      end
+
+      it "will accept partial matches of 'minutes' (i.e. m min mins minute minutes)" do
+        weird_minutes = "10 min"
+        term_alt = Termodoro.new(weird_minutes)
+        expect(term_alt.calculate_time).to eq(600)
+      end
+
+      it "will accept partial matches of 'hours' (i.e. h hr hrs hour hours)" do
+        weird_hours = "1 hr"
+        term_alt = Termodoro.new(weird_hours)
+        expect(term_alt.calculate_time).to eq(3600)
+      end
+
+      it "allows user to smush time unit directly onto decimal without a space (i.e. 10secs, 5minute, etc.)" do
+        spaceless_seconds = "10secs"
+        term_alt = Termodoro.new(spaceless_seconds)
+        expect(term_alt.calculate_time).to eq(10)
+      end
+
+    end
   end
 
-  it "allows the message to be optional" do
-    arg = "10 seconds"
-    term = Termodoro.new(arg)
-    term.command.should be_an_instance_of(String)
+  describe "Internal logic" do
+    it "can calculate the time given a unit of time" do
+      minute_message = "5 minutes"
+      term_alt = Termodoro.new(minute_message)
+      expect(term_alt.calculate_time).to eq(300)
+    end
+
+    it "can santize the message" do
+      pending "This feature needs to be built. Sort of important."
+    end
+
+  end
+
+  describe "Command line behavior and other shell support" do
+    it "Coming soon..." do
+      pending "This needs to be built and explored"
+    end
   end
+
 end
+
+

data/termodoro.gemspec

@@ -1,7 +1,8 @@
+
 Gem::Specification.new do |s|
   s.name        = 'termodoro'
-  s.version     = '0.2.6'
-  s.date        = '2013-10-24'
+  s.version     = '0.3.0'
+  s.date        = '2013-10-30'
   s.summary     = "A lightweight CL reminder app"
   s.description = "Use this little utility to set simple reminders from the command line. See the github page below for more information"
   s.authors     = ["Vinney Cavallo"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termodoro
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Vinney Cavallo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terminal-notifier