timr 0.3.0 → 0.4.0

data/lib/timr/command/version_command.rb

@@ -0,0 +1,18 @@
+
+module TheFox
+	module Timr
+		module Command
+			
+			class VersionCommand < BasicCommand
+				
+				# See BasicCommand#run.
+				def run
+					puts "#{NAME} #{VERSION} (#{DATE})"
+					puts "#{HOMEPAGE}"
+				end
+				
+			end # class VersionCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/duration.rb

@@ -0,0 +1,159 @@
+
+require 'chronic_duration'
+
+module TheFox
+	module Timr
+		
+		# Uses seconds as basis.
+		class Duration
+			
+			include Error
+			
+			# Basis Data (Integer)
+			# 
+			# A Duration is stored as seconds.
+			attr_reader :seconds
+			
+			def initialize(seconds = 0)
+				@seconds = seconds.to_i
+				
+				@smh_seconds = nil
+				@smh_minutes = nil
+				@smh_hours = nil
+			end
+			
+			# Seconds, Minutes, Hours as Array
+			def to_smh
+				@smh_seconds = @seconds
+				
+				@smh_hours = @smh_seconds / 3600
+				
+				@smh_seconds -= @smh_hours * 3600
+				@smh_minutes = @smh_seconds / 60
+				
+				@smh_seconds -= @smh_minutes * 60
+				
+				[@smh_seconds, @smh_minutes, @smh_hours]
+			end
+			
+			# Converts seconds to `nh nm ns` format. Where `n` is a number.
+			def to_human
+				dur_opt = {
+					:format => :short,
+					:limit_to_hours => true,
+					:keep_zero => false,
+					:units => 2,
+				}
+				h = ChronicDuration.output(@seconds, dur_opt)
+				
+				h ? h : '---'
+			end
+			
+			# Man-days, Man-hours
+			# 
+			# Man Unit:
+			# 
+			# - 8 hours are 1 man-day.
+			# - 5 man-days are 1 man-week, and so on.
+			def to_man_days
+				if @seconds < 28800 # 8 * 3600 = 1 man-day
+					to_human
+				elsif @seconds < 144000 # 5 * 28800 = 1 man-week
+					seconds = @seconds
+					
+					man_days = seconds / 28800
+					
+					seconds -= man_days * 28800
+					man_hours = seconds / 3600
+					
+					'%dd %dh' % [man_days, man_hours]
+				else
+					seconds = @seconds
+					
+					man_weeks = seconds / 144000
+					
+					seconds -= man_weeks * 144000
+					man_days = seconds / 28800
+					
+					seconds -= man_days * 28800
+					man_hours = seconds / 3600
+					
+					'%dw %dd %dh' % [man_weeks, man_days, man_hours]
+				end
+			end
+			
+			# Adds two Durations.
+			def +(duration)
+				case duration
+				when Integer
+					Duration.new(@seconds + duration)
+				when Duration
+					Duration.new(@seconds + duration.seconds)
+				when nil
+					Duration.new(@seconds)
+				else
+					raise DurationError, "Wrong type #{duration.class} for '+' function."
+				end
+			end
+			
+			# Subtract two Durations.
+			def -(duration)
+				case duration
+				when Integer
+					diff = @seconds - duration
+				when Duration
+					diff = @seconds - duration.seconds
+				else
+					raise DurationError, "Wrong type #{duration.class} for '+' function."
+				end
+				
+				if diff < 0
+					diff = 0
+				end
+				Duration.new(diff)
+			end
+			
+			# Lesser
+			def <(obj)
+				case obj
+				when Integer
+					@seconds < obj
+				when Duration
+					@seconds < obj.to_i
+				end
+			end
+			
+			# Greater
+			def >(obj)
+				case obj
+				when Integer
+					@seconds > obj
+				when Duration
+					@seconds > obj.to_i
+				end
+			end
+			
+			# String
+			def to_s
+				@seconds.to_s
+			end
+			
+			# Use this instead of `Duration.seconds`.
+			def to_i
+				@seconds
+			end
+			
+			# All methods in this block are static.
+			class << self
+				
+				# Parse a String using [ChronicDuration](https://rubygems.org/gems/chronic_duration) and create a new Duration instance.
+				def parse(str)
+					Duration.new(ChronicDuration.parse(str))
+				end
+				
+			end
+			
+		end # class Duration
+		
+	end # module Timr
+end # module TheFox

data/lib/timr/exception/timr_error.rb

@@ -0,0 +1,113 @@
+
+module TheFox
+	module Timr
+		
+		# # Errors Inheritance Tree
+		# 
+		# TimrError is the basic class for all Timr Error classes. It subclasses from [Rubys StandardError](http://ruby-doc.org/core-2.4.1/Exception.html).
+		# 
+		# - TimrError
+		# 	- ModelError
+		# 		- IdError
+		# 		- ForeignIdError
+		# 		- TaskError
+		# 		- TrackError
+		# 		- StackError
+		# 	- DateTimeHelperError
+		# 	- TerminalHelperError
+		# 	- CommandError
+		# 		- ContinueCommandError
+		# 		- LogCommandError
+		# 		- PauseCommandError
+		# 		- PopCommandError
+		# 		- PushCommandError
+		# 		- ReportCommandError
+		# 		- StartCommandError
+		# 		- StatusCommandError
+		# 		- StopCommandError
+		# 		- TaskCommandError
+		# 		- TrackCommandError
+		# 		- HelpCommandError
+		# 	- DurationError
+		# 	- ThisShouldNeverHappenError
+		module Error
+		
+			class TimrError < StandardError
+			end
+			
+			class ModelError < TimrError
+			end
+			
+			class IdError < ModelError
+			end
+			
+			class ForeignIdError < ModelError
+			end
+			
+			class TaskError < ModelError
+			end
+			
+			class TrackError < ModelError
+			end
+			
+			class StackError < ModelError
+			end
+			
+			# Use by TheFox::Timr::Helper::DateTimeHelper.
+			class DateTimeHelperError < TimrError
+			end
+			
+			# Use by TheFox::Timr::Helper::TerminalHelper.
+			class TerminalHelperError < TimrError
+			end
+			
+			class CommandError < TimrError
+			end
+			
+			class ContinueCommandError < CommandError
+			end
+			
+			class LogCommandError < CommandError
+			end
+			
+			class PauseCommandError < CommandError
+			end
+			
+			class PopCommandError < CommandError
+			end
+			
+			class PushCommandError < CommandError
+			end
+			
+			class ReportCommandError < CommandError
+			end
+			
+			class StartCommandError < CommandError
+			end
+			
+			class StatusCommandError < CommandError
+			end
+			
+			class StopCommandError < CommandError
+			end
+			
+			class TaskCommandError < CommandError
+			end
+			
+			class TrackCommandError < CommandError
+			end
+			
+			class HelpCommandError < CommandError
+			end
+			
+			class DurationError < TimrError
+			end
+			
+			# This should really never happen. But you never know. ;)
+			class ThisShouldNeverHappenError < TimrError
+			end
+			
+		end # module Error
+		
+	end # module Timr
+end # module TheFox

data/lib/timr/ext/time.rb

@@ -0,0 +1,12 @@
+
+# Extend core [Time](http://ruby-doc.org/stdlib-2.4.0/libdoc/time/rdoc/Time.html) class.
+class Time
+	
+	# See [How do I get elapsed time in milliseconds in Ruby?](http://stackoverflow.com/questions/1414951/how-do-i-get-elapsed-time-in-milliseconds-in-ruby)
+	# 
+	# Not really used. Only to measure the execution from start to end. See `bin/timr`.
+	def to_ms
+		(self.to_f * 1000.0).to_i
+	end
+	
+end

data/lib/timr/helper/datetime_helper.rb

@@ -0,0 +1,128 @@
+
+require 'date'
+require 'time'
+
+module TheFox
+	module Timr
+		module Helper
+			
+			# This class should *NOT* replace [Time](http://ruby-doc.org/core-2.4.1/Time.html), [Date](http://ruby-doc.org/stdlib-2.4.1/libdoc/date/rdoc/Date.html) or [DateTime](http://ruby-doc.org/stdlib-2.4.1/libdoc/date/rdoc/DateTime.html).
+			class DateTimeHelper
+				
+				# All methods in this block are static.
+				class << self
+					
+					include TheFox::Timr::Error
+					
+					# Convert String to Date.
+					def convert_date(date)
+						case date
+						when String
+							Time.parse(date).utc.to_date
+						when nil
+							Time.now.utc.to_date
+						end
+					end
+					
+					# Convert String to Time.
+					def convert_time(time)
+						case time
+						when String
+							Time.parse(time).utc
+						when nil
+							Time.now.utc
+						end
+					end
+					
+					# Parse an argv Array.
+					# 
+					# Create a `from` and `to` for a day.
+					def parse_day_argv(argv)
+						day = argv.shift
+						from = Time.parse("#{day} 00:00:00")
+						to   = Time.parse("#{day} 23:59:59")
+						[from, to]
+					end
+					
+					# Parse an argv Array.
+					# 
+					# Create a `from` and `to` for a month.
+					def parse_month_argv(argv)
+						parts = argv.shift.split('-').map{ |s| s.to_i }
+						if parts.count == 1
+							y = Date.today.year
+							m = parts.first
+						else
+							y, m = parts
+						end
+						if y < 2000 # shit
+							y += 2000
+						end
+						
+						start_date = Date.new(y, m, 1)
+						end_date   = Date.new(y, m, -1)
+						
+						from = Time.parse("#{start_date.strftime('%F')} 00:00:00")
+						to   = Time.parse("#{end_date.strftime('%F')} 23:59:59")
+						[from, to]
+					end
+					
+					# Parse an argv Array.
+					# 
+					# Create a `from` and `to` for a year.
+					def parse_year_argv(argv)
+						y = argv.shift
+						if y
+							y = y.to_i
+						else
+							y = Date.today.year
+						end
+						if y < 2000 # shit
+							y += 2000
+						end
+						
+						start_date = Date.new(y, 1, 1)
+						end_date   = Date.new(y, 12, -1)
+						
+						from = Time.parse("#{start_date.strftime('%F')} 00:00:00")
+						to   = Time.parse("#{end_date.strftime('%F')} 23:59:59")
+						[from, to]
+					end
+					
+					# Create a Time instance from a Hash.
+					# 
+					# Options:
+					# 
+					# - `:date` String
+					# - `:time` String
+					def get_datetime_from_options(options = Hash.new)
+						date_opt = options.fetch(:date, nil)
+						time_opt = options.fetch(:time, nil)
+						
+						if date_opt && !time_opt
+							raise DateTimeHelperError, 'You also need to set a time when giving a date.'
+						end
+						
+						datetime_a = []
+						if date_opt
+							datetime_a << date_opt
+						end
+						if time_opt
+							datetime_a << time_opt
+						end
+						
+						if datetime_a.count > 0
+							datetime_s = datetime_a.join(' ')
+							Time.parse(datetime_s).utc
+						else
+							Time.now.utc
+						end
+					end
+					
+				end
+				
+			end # class DateTimeHelper
+			
+		end # module Helper
+	end # module Timr
+end # module TheFox

data/lib/timr/helper/terminal_helper.rb

@@ -0,0 +1,58 @@
+
+module TheFox
+	module Timr
+		module Helper
+			
+			# This class helps with Terminal operations.
+			class TerminalHelper
+				
+				# All methods in this block are static.
+				class << self
+					
+					include TheFox::Timr::Error
+					
+					# Run external editor via EDITOR environment variable.
+					def run_external_editor(text = nil)
+						case text
+						when Array
+							text = text.join("\n")
+						end
+						
+						if !ENV['EDITOR'] || ENV['EDITOR'].length == 0
+							raise TerminalHelperError, 'EDITOR environment variable not set.'
+						end
+						
+						tmpfile = Tempfile.new('timr_message')
+						if text
+							tmpfile.write(text)
+						end
+						tmpfile.close
+						
+						system_s = '%s %s' % [ENV['EDITOR'], tmpfile.path]
+						system(system_s)
+						
+						tmpfile.open
+						tmpfile_lines = tmpfile.read
+						tmpfile.close
+						
+						tmpfile_lines
+							.split("\n")
+							.select{ |row| row[0] != '#' }
+							.join("\n")
+					end
+					
+					# Print help to external editor.
+					def external_editor_help(edit_text)
+						edit_text << '# This is a comment.'
+						edit_text << '# The first line should be a sentence. Sentence have dots at the end.'
+						edit_text << '# The second line should be empty, if you provide a more detailed'
+						edit_text << '# description from on the third line. Like on Git.'
+					end
+					
+				end
+				
+			end # class TerminalHelper
+			
+		end # module Helper
+	end # module Timr
+end # module TheFox