termodoro 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e28ec45a4d531ae0799b06ce31cd75ec88edf3b7
-  data.tar.gz: a85d9385d4e7aaad04cfb9948c338066be54b27b
+  metadata.gz: 7682de14275ca02cf30abbe59667d3da687c0efe
+  data.tar.gz: a70da49bae67f5e40bbf256d7037b47350e5d85e
 SHA512:
-  metadata.gz: 39845df2b62a2d2d28cd113e228b0d6dc2a9f08e9a4028265e2974fd32dcaafde1bf9b74996e66fd4f589400791be2e0532b14a37e77a81ddd51425da7e19096
-  data.tar.gz: 00966d8256cb2d33359e3aa8eb2be226da9884717327f6476f54b315072483dad8e4d077d5b2c21d394e33a139d95c04c70cbdf502cdc9f882ca0ea97cc20450
+  metadata.gz: c4008f442898bffc655229d1f949d148ea4dcf0ccce288925c89925e0413d27fe4e30a4b4c115bd38dc40445f93028d77b36fcb7e4a5c171b88ed492dbc6d199
+  data.tar.gz: d83df704e3cd2fc09b335c16d69afbae37734392c96dbe91a7472298e0f39dae87defd28d878db263ea61e282b093ab5db2c649e3f5fbef313ca58c3eda9191d

data/CHANGELOG.md

@@ -1,11 +1,15 @@
+### 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.
+
 ### 0.2.5 (10/29/2013)
  
 * Integrate Travis CI. Add Bundler and Rake. Add License. Minor changes to gemspec file. Add this changelog file.
 
 ### 0.2.0 (10/29/2013)
 
-* Adds [@scottcreynold](https://github.com/scottcreynolds)'s feature which allows for omitting the message. Also includes the first tests. - [@vcavallo](http://github.com/vcavallo)
+- Adds [@scottcreynold](https://github.com/scottcreynolds)'s feature which allows for omitting the message. Also includes the first tests. - [@vcavallo](http://github.com/vcavallo)
 
 ### 0.1.9 (10/24/2013)
 
-* First working public release. - [@vcavallo](http://github.com/vcavallo)
+- First working public release. - [@vcavallo](http://github.com/vcavallo)

data/README.md

@@ -1,5 +1,8 @@
 # Termodoro
 
+[![Gem Version](https://badge.fury.io/rb/termodoro.png)](http://badge.fury.io/rb/termodoro)  
+[![Build Status](https://travis-ci.org/vcavallo/termodoro.png)](https://travis-ci.org/vcavallo/termodoro)
+
 ## What is this?
 
 ***Termodoro*** is an ultra-simple, frictionless BASH reminder / pomodoro timer ( in fact it's portmanteau of *terminal* and *[pomodoro](http://en.wikipedia.org/wiki/Pomodoro_Technique)* )  
@@ -47,12 +50,11 @@ This is the first gem I've built. I do not claim that it is perfect, nor that it
   - set defaults to something agreeable (like maybe 20 minutes and some generic 'do that thing you wanted to do' message) such that you could just do `termodoro` and it'll do that default.
   - Make it useable in other shells and without the terminal-notifier gem.
   - Sanitize the message so as to not cause bash issues
-  - Write good tests!
-  - Make sure to follow gem best-practices
+  - Write good tests! *(getting there)*
+  - Make sure to follow gem best-practices *(Might be done with this one...)*
   - A bunch of other stuff I'll add here
   - Make sure it persists through computer sleep
   - Make sure I'm using ARGV properly and issuing the system command properly
-    - Generally revise to adhere to best practices. 
 
 ## Upcoming features:
 

data/lib/termodoro/termodoro.rb

@@ -1,84 +1,120 @@
 
-class Termodoro
-  attr_accessor :time_part, :number_part, :message
 
+# 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
+# a terminal-notifier message appears with the message - if the message was omitted,
+# the word "Termodoro" appears instead.
+class Termodoro
+  attr_accessor :time_unit, :number_of_units, :message
+  # @!attribute time_unit
+  #   @return [String] the unit of time specified by the user.
+  # @!attribute number_of_units
+  #   @return [Integer] the number of units of time specified by the user.
+  # @!attribute message
+  #   @return [String] the message specified by the user.
+
+  # Used in multiplication to arrive at the number of seconds in a minute.
   SECS_IN_MIN = 60
+  # Used in multiplication to arrive at the number of seconds in an hour.
   SECS_IN_HOUR = 3600
 
+  # @param arguments [String] The arguments passed in by the user at the command 
+  #   line. this includes the time after which the reminder will appear and an 
+  #   optional message to appear in the body of the reminder.
   def initialize(arguments)
     @arguments = arguments
-
-    # message
-    # title on/off -- probably going to drop this
   end
 
-  # parse class
-    # Parse.new(input)
-      # 
-  # calculate class
-  # run clean_message
-
-  def parse_time_part
+  # Looks into the user-supplied arguments and retreives the unit of time. 
+  # @return [String] a version of hours, minutes or seconds, depending on
+  # how the user inputs it ("s", "Sec", "seconds", etc.)
+  def parse_time_unit
     segment = @arguments.match(/\D+/)[0].split(' ').first
-    self.time_part = segment
-    #=> hours/minutes/seconds, etc.
+    self.time_unit = segment
   end
 
-  def parse_number_part
+  # Looks into the user-supplied arguments and parses out the number of units of
+  # time.
+  # @return [Integer] the number of units of time given by the user.
+  def parse_number_of_units
     number = @arguments.scan(/[\d]+/).first.strip.to_i
-    self.number_part = number
-    #=> the number of time_parts given
+    self.number_of_units = number
   end
 
+  # Looks into the user-supplied arguments and returns the message, if one is present.
+  # If not, sets the message to "Termodoro".
+  # @return [String] the optional message given by the user.
   def parse_message
     # .split(/[\d]+.[\w]+/).last 
     parsed_message = @arguments.split(/^\s*[\d]+\s*[\w]+/).last || 'Termodoro'
     self.message = parsed_message.strip
   end
 
+  # Depending on what unit of time is being used, determines the number of seconds
+  # using multiplication by {Termodoro::SECS_IN_MIN SECS_IN_MIN} and 
+  # {Termodoro::SECS_IN_HOUR SECS_IN_HOUR} constants. The check to #seconds? is 
+  # not necessary, but feels nice.
+  # @see #parse_number_of_units
+  # @see #seconds?
+  # @see #minutes?
+  # @see #hours?
+  # @return [Integer] total number of seconds for which to wait until the reminder
+  #   is displayed.
   def calculate_time
     if minutes?
-      seconds = parse_number_part * SECS_IN_MIN
+      seconds = parse_number_of_units * SECS_IN_MIN
     elsif hours?
-      seconds = parse_number_part * SECS_IN_HOUR
+      seconds = parse_number_of_units * SECS_IN_HOUR
     elsif seconds?
-      seconds = parse_number_part
+      seconds = parse_number_of_units
     end
 
-    seconds #=> returns seconds
+    seconds
   end
 
+
+  # Truthy if user has input a number of seconds.
+  # @return [Boolean] 
+  # @see #parse_time_unit
   def seconds?
     seconds = %w[s sec secs second seconds]
-    true if seconds.include?(parse_time_part)
-    #=> true/false
+    true if seconds.include?(parse_time_unit)
   end
 
+  # Truthy if user has input a number of minutes. 
+  # @return [Boolean] 
+  # @see #parse_time_unit
   def minutes?
     minutes = %w[m min mins minute minutes]
-    true if minutes.include?(parse_time_part)
-    #=> true/false
+    true if minutes.include?(parse_time_unit)
   end
 
+  # Truthy if user has input a number of hours. 
+  # @see #parse_time_unit
+  # @return [Boolean] 
   def hours?
     hours = %w[h hr hrs hour hours]
-    true if hours.include?(parse_time_part)
-    #=> true/false
+    true if hours.include?(parse_time_unit)
   end
 
+  # 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
-    # will need something to sanitize apostrophes and stuff
-    #=> return sanitized message to insert into terminal
   end
 
+  # Workhorse method: Runs #calculate_time and #parse_message, taking the results
+  # of those methods and creating the string to execute.
+  # @see #calculate_time
+  # @see #parse_message
+  # @return [String] the fully-formed command string ready to be run by bash as 
+  #   a system command.
   def command
-    # title = "title" -- leaving off title for now.
-    # if title on/off call one or the other
-    time_part = calculate_time
+    time_unit = calculate_time
     msg_part = parse_message
-    "sleep #{time_part} && terminal-notifier -message '#{msg_part}' -title 'Termodoro' & disown"
-    #=> return the fully-formed command string for Bash
+    "sleep #{time_unit} && terminal-notifier -message '#{msg_part}' -title 'Termodoro' & disown"
   end
 
 end

data/termodoro.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'termodoro'
-  s.version     = '0.2.5'
+  s.version     = '0.2.6'
   s.date        = '2013-10-24'
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: termodoro
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Vinney Cavallo