devlog 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57d73038e69a1550073fd71d8272085ad3feb660
-  data.tar.gz: a234e808266dbcd543ec9f35f06cc2d2f3ea5729
+  metadata.gz: c17dd2cce02aef60e7d7bc439502746a2fe7ae91
+  data.tar.gz: 6c6dc8f2d7ecdb2d891680a39505f623dd712d9f
 SHA512:
-  metadata.gz: b8b88776ad5e576499f5915aaec0ef8c48b7490fc096cdcb217233cd711363cf48a3a8363be4b8cdad9ce31f4e2af75ddb5172f1b1cbbee6c7e865196eac1f50
-  data.tar.gz: b81742c5df67f1f985908e93a6e0db8c5fb86763dc28d3d5a6ef94b2c1a806f86f7bcd7a1796393bf66fb8babbb9c07e58f110b5b9d31169511dfc368d98a39c
+  metadata.gz: 380f4bc48f1de2d19d58d5a9a34c46d0150567deb3f4859c0d84fa106daaa4354ff043664df17e20c8e8c9ba3563ee1461f7df578f23115eb665e000352fa2be
+  data.tar.gz: 3aa058eefadc8f68692ad7d04f2091b52d9e6fcdecb453fa38fb1094d9964f1689054040f93819c66e29b9564eb6104059fa11c27cc49e51e29003380d92367c

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/bin/devlog

@@ -2,15 +2,18 @@
 require 'benchmark'
 require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib devlog.rb]))
 USAGE= <<-EOF
-  #{Devlog.display_version}
+#{Devlog.display_version}
+This software is intended to parse and present information within devlog.markdown development logs.
 
-  This software is intended to parse and present information within devlog.markdown development logs.
+#{'Use it as You'.green} #{'dodo'.pur}.
 
-  #{'Use it as You'.green} #{'dodo'.pur}.
+Using with a file:
 
-  Usage:
+  #{'devlog'.red} /path/to/devlog.markdown
 
-    #{'devlog'.red} /path/to/devlog.markdown
+or just in a folder with a 'devlog.markdown' file:
+
+  #{'devlog'.green} 
 
 EOF
 #arguments
@@ -18,40 +21,35 @@ $:.unshift File.join(File.dirname(__FILE__))
 @in_file = ARGV[0]
 def print_usage
   puts USAGE
-  exit
 end
 def dodo
-  if @in_file
-    include Devlog
-    time = Benchmark.realtime do 
+  include Devlog
+  time = Benchmark.realtime do 
+    if @in_file
+      puts "Parsing #{@in_file}...".red
       t = parse_devlog_now(@in_file)
-      puts "\nSession::Time:      = #{t.session_time} [h]\n"
-      puts("\nCodingSession::Time = %.1f [h]" % t.coding_session_time)
-      puts("\nComSession::Time    = %.1f [h]" % t.com_session_time)
-      puts("\nCharge::Time        = #{t.charge_time} [h]")
-      puts("\nUnpayed::Time       = #{t.unpayed_time} [h]\n")
-      puts("\n")
-      puts("Num of Sessions     = #{t.devlog_sessions.size}\n")
-      puts("Hours per Day       = #{t.per_day} [h]\n")
-      puts("Hours per Week      = #{t.per_week} [h]\n")
-      puts("Hours per Month     = #{t.per_month} [h]\n")
-      puts("Hours last 7 days   = #{t.hours_for_last(7)} [h]\n")
-      puts("Hours last 14 days   = #{t.hours_for_last(14)} [h]\n")
-      puts("Hours last 28 days   = #{t.hours_for_last(28)} [h]\n")
-      puts("\n")
-      puts("Devlog Time         = #{t.devlog_days * 24} [hours]\n")
-      puts("Devlog Days         = #{t.devlog_days}  [days]\n")
-      puts("Devlog Weeks        = #{t.devlog_weeks}  [weeks]\n")
-      puts("Devlog Months       = #{t.devlog_months}  [months]\n")
-      puts("\n")
-      puts("Longest Session     = #{t.longest_session.session_time.round(2)} [hours]\n")
-      puts("Shortest Session     = #{t.shortest_session.session_time.round(2)} [hours]\n")
+      puts t.validation_string
+      puts t.to_info_string
+    else
+      puts "Parsing devlog.markdown in current folder...".green
+      t = parse_devlog_now("devlog.markdown") #try default file
+      puts t.validation_string
+      puts t.to_info_string
     end
-    puts "\nRealtime used : #{time}sec"
-  end
+ end
+ puts "\nRealtime used : #{time}sec\n\n"
 end
-if ARGV.size > 0
-  dodo
-else
-  print_usage
+
+begin
+
+  if ARGV.size > 0
+    dodo
+  else
+      dodo
+  end
+
+rescue
+    print_usage
 end
+
+#exit

data/devlog.gemspec

@@ -2,16 +2,14 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: devlog 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "devlog"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["mihael"]
-  s.date = "2014-02-10"
+  s.date = "2014-08-15"
   s.description = "devlog.markdown time&space extractor"
   s.email = "kitschmaster@gmail.com"
   s.executables = ["devlog"]
@@ -47,12 +45,14 @@ Gem::Specification.new do |s|
     "test/devlog_test.rb",
     "test/test_helper.rb",
     "test_devlog.markdown",
+    "test_negative_devlog.markdown",
     "test_single_devlog.markdown",
     "test_stats_devlog.markdown"
   ]
   s.homepage = "http://github.com/mihael/devlog"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.1"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.14"
   s.summary = "takes devlog.markdown and gives info"
 
   if s.respond_to? :specification_version then

data/devlog.markdown

@@ -1,10 +1,23 @@
+#15.08.2014 19:14:21 CodingSession::END
+
+adding some nice stuff... can now see negative and zero sessions, which are basically error entries with zero or negative time.
+
+line numbers are recorded, and printed next to the zero and negative sessions...
+
+running 'devlog' in a folder where there is a devlog.markdown file present, it will attempt to parse and present info...
+
+improved the output...
+
+0.0.3 it is
+
+#15.08.2014 16:35:49 CodingSession::BEGIN
+
 #03.02.2014 21:02:30 CodingSession::END
 
 added some tests, and some new calculations, the devlog binary prints out better stats... 0.0.1 it is.
 
 #03.02.2014 09:37:36 CodingSession::BEGIN
 
-
 #02.02.2014 17:06:00 CodingSession::END
 
 experiencing some bad weather, which took down an optical cable and cut our village off the internet grid...

data/lib/devlog.rb

@@ -14,7 +14,7 @@ module Devlog
   # :stopdoc:
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  VERSION = File.open(File.join(File.dirname(__FILE__), %w[.. VERSION]), 'r') 
+  VERSION = File.open(File.join(File.dirname(__FILE__), %w[.. VERSION]), 'r').read
   # :startdoc:
   # Returns the version string for the library.
   #
@@ -48,13 +48,12 @@ module Devlog
     Dir.glob(search_me).sort.each {|rb| require rb}
   end
   def self.display_version
-    "\n#{'Devlog'.green} v#{Devlog.version}\n\n"
+    "\n#{'Devlog'.green} v#{Devlog.version}\n"
   end
   # Write siple console log
   def self.log(txt)
     puts "#{txt}"
   end
-
   
   def parse_datetime(line)
     parts = line[1..-1].split
@@ -63,28 +62,40 @@ module Devlog
 
   def parse_devlog_now(devlog=nil)
     t = Parsing.new
+    t.devlog_file = devlog
+
     return t unless devlog
+    return t unless File.exist?(devlog)
 
     timeEnd = nil
     timeBegin = nil
+    timeEnd_line_number = nil
+    timeBegin_line_number = nil
     in_session = false
     temp_zezzion = nil
 
+    line_number = 0
     File.open(devlog, "r").each do |line|
+      line_number+=1 
+      
       if line =~ /-NOCHARGE/
         in_session = false #do not count nocharge sessions, this is a secret feature
       elsif line =~ /\A#/ && line =~ /CodingSession::END/
         in_session = true
         timeEnd = parse_datetime(line)
+        timeEnd_line_number = line_number
         
         #zezzion
         temp_zezzion = Zezzion.new
         temp_zezzion.zzend = timeEnd
+        temp_zezzion.zzend_line_number = timeEnd_line_number
 
       elsif line =~ /\A#/ && line =~ /CodingSession::BEGIN/
         if in_session
           in_session = false
           timeBegin = parse_datetime(line)
+          timeBegin_line_number = line_number
+
           #cs_time += (timeEnd - timeBegin).to_f * 24 #hours *60 #minutes *60 #seconds
           delta = (timeEnd - timeBegin).to_f * 24 #hours *60 #minutes *60 #seconds
           t.coding_session_time += delta
@@ -92,6 +103,7 @@ module Devlog
           #zezzion
           temp_zezzion.coding_session_time += delta
           temp_zezzion.zzbegin = timeBegin
+          temp_zezzion.zzbegin_line_number = timeBegin_line_number
           t.add_zezzion temp_zezzion
           temp_zezzion = nil
 
@@ -99,22 +111,26 @@ module Devlog
       elsif line =~ /\A#/ && line =~ /ComSession::END/
         in_session = true
         timeEnd = parse_datetime(line)
+        timeEnd_line_number = line_number
 
         #zezzion
         temp_zezzion = Zezzion.new(Zezzion::COM)
         temp_zezzion.zzend = timeEnd
-
+        temp_zezzion.zzend_line_number = timeEnd_line_number
 
       elsif line =~ /\A#/ && line =~ /ComSession::BEGIN/
         if in_session
           in_session = false
           timeBegin = parse_datetime(line)
+          timeBegin_line_number = line_number
+
           delta = (timeEnd - timeBegin).to_f * 24
           t.com_session_time += delta
 
           #zezzion
           temp_zezzion.coding_session_time += delta
           temp_zezzion.zzbegin = timeBegin
+          temp_zezzion.zzbegin_line_number = timeBegin_line_number
           t.add_zezzion temp_zezzion
           temp_zezzion = nil
 
@@ -200,10 +216,10 @@ module Devlog
   end
 
   class Parsing
-    #this is the total time, but each sessino has these same params
+    #this is the total time, but each session has these same params
     attr_accessor :coding_session_time, :com_session_time, :payed_time #backward compatible object with Tajm, from devlog 0.0.0
 
-    attr_accessor :zezzions
+    attr_accessor :zezzions, :devlog_file
 
     def initialize(viewing_time_current_date=DateTime.now)
       @viewing_time_current_date = viewing_time_current_date
@@ -213,13 +229,15 @@ module Devlog
       @coding_session_time = 0.0
       @com_session_time = 0.0
       @payed_time = 0.0
+
+      @devlog_file = ""
      end
 
     def add_zezzion(zezzion)
       @zezzions << zezzion
     end
 
-    #gloabl devlog start, first entry
+    #global devlog start, first entry
     def devlog_begin
       @zezzions.last.zzbegin
     end
@@ -291,14 +309,80 @@ module Devlog
       @zezzions.min_by(&:session_time)
     end
 
+    def negative_sessions
+      @zezzions.select{|zezzion| zezzion.session_time<0}
+    end
+
+    def zero_sessions
+      @zezzions.select{|zezzion| zezzion.session_time==0.0}
+    end
+
+    def zero_sessions_to_s
+      sessions_to_s(zero_sessions)
+    end
+
+    def negative_sessions_to_s
+      sessions_to_s(negative_sessions)
+    end
+
+    def last_session
+      @zezzions.first #devlog_begin
+    end
+
+    def first_session
+      @zezzions.last #devlog_end
+    end
+
     #return all sessions
     def devlog_sessions
       @zezzions
     end
 
+    def validation_string
+      vs = ""
+      vs << (@zezzions.any? ? '' : "No sessions recorded, add some first...\n".red)
+      vs << (File.exist?(self.devlog_file) ? '' : "No such file #{self.devlog_file}...\n".red)
+    end
 
+    def to_info_string
+      s = ""
+      s <<  "\nSession::Time:      = #{self.session_time} [h]\n"
+      s << ("\nCodingSession::Time = %.1f [h]" % self.coding_session_time)
+      s << ("\nComSession::Time    = %.1f [h]" % self.com_session_time)
+      s << ("\nCharge::Time        = #{self.charge_time} [h]")
+      s << ("\nUnpayed::Time       = #{self.unpayed_time.to_s.green} [h]\n")
+      s << ("\n")
+      s << ("Num of Sessions     = #{self.devlog_sessions.size}\n")
+      s << ("Hours per Day       = #{self.per_day} [h]\n")
+      s << ("Hours per Week      = #{self.per_week} [h]\n")
+      s << ("Hours per Month     = #{self.per_month} [h]\n")
+      s << ("Hours last 7 days   = #{self.hours_for_last(7)} [h]\n")
+      s << ("Hours last 14 days  = #{self.hours_for_last(14)} [h]\n")
+      s << ("Hours last 28 days  = #{self.hours_for_last(28)} [h]\n")
+      s << ("\n")
+      s << ("Devlog Time         = #{self.devlog_days * 24} [hours]\n")
+      s << ("Devlog Days         = #{self.devlog_days}  [days]\n")
+      s << ("Devlog Weeks        = #{self.devlog_weeks}  [weeks]\n")
+      s << ("Devlog Months       = #{self.devlog_months}  [months]\n")
+      if self.negative_sessions.any?
+        s << ("\n")
+        s << ("#{'Negative Sessions'.red}   = #{self.negative_sessions_to_s}\n")
+      end
+      if self.zero_sessions.any?
+        s << ("\n")
+        s << ("#{'Zero Sessions'.blue}       = #{self.zero_sessions_to_s}\n")
+      end
+      s << ("\n")
+      s << ("Longest Session     = #{self.longest_session.session_time.round(2)} [hours]\n")
+      s << ("Shortest Session    = #{self.shortest_session.session_time.round(2)} [hours]\n")
+      s << ("Last Session        = #{self.devlog_end.ago_in_words}, duration: #{self.last_session.session_time.round(2)} [hours]")
+    end
 
     private 
+      def sessions_to_s(sessions)
+        "\n" + sessions.collect{|session| "                      " + session.to_s}.join("\n")
+      end
+
       #count :weeks=>1, or :days=>1, or :years=>1
       def count_time(options)
         num = 0
@@ -314,10 +398,11 @@ module Devlog
 
 
   class Zezzion
-    COM = 1
-    COD = 0
+    COM = 1 #communication session
+    COD = 0 #coding session
     attr_accessor :zzbegin, :zzend, :zzbegin_title, :zzend_title, :zztype
     attr_accessor :coding_session_time, :com_session_time, :payed_time
+    attr_accessor :zzend_line_number, :zzbegin_line_number
 
     def initialize(zztype=COD)
       @zztype = zztype
@@ -329,6 +414,8 @@ module Devlog
       @coding_session_time = 0.0
       @com_session_time = 0.0
       @payed_time = 0.0
+      @zzbegin_line_number = 0
+      @zzend_line_number = 0
     end
 
     #in seconds
@@ -354,10 +441,18 @@ module Devlog
       session_time/days
     end
     def per_week
-      
+      #todo
     end
     def per_month
+      #todo
+    end
 
+    def type
+      zztype == 0 ? "CodingSession" : "ComSession"
+    end
+
+    def to_s
+      "#{type}, begin on line #{@zzbegin_line_number} at #{@zzbegin}, ends on line #{@zzend_line_number} at #{@zzend}, #{session_time.round(2)}[hour]"
     end
   end
 
@@ -371,5 +466,37 @@ module Devlog
     end
 
   end
-  
+
+end
+
+module DateTimeAgoInWords
+  def ago_in_words
+    return 'a very very long time ago' if self.year < 1800
+    secs = Time.now - self
+    return 'just now' if secs > -1 && secs < 1
+    return '' if secs <= -1
+    pair = ago_in_words_pair(secs)
+    ary = ago_in_words_singularize(pair)
+    ary.size == 0 ? '' : ary.join(' and ') << ' ago'
+  end
+  private
+  def ago_in_words_pair(secs)
+    [[60, :seconds], [60, :minutes], [24, :hours], [100_000, :days]].map{ |count, name|
+      if secs > 0
+        secs, n = secs.divmod(count)
+        "#{n.to_i} #{name}"
+      end
+    }.compact.reverse[0..1]
+  end
+  def ago_in_words_singularize(pair)
+    if pair.size == 1
+      pair.map! {|part| part[0, 2].to_i == 1 ? part.chomp('s') : part }
+    else
+      pair.map! {|part| part[0, 2].to_i == 1 ? part.chomp('s') : part[0, 2].to_i == 0 ? nil : part }
+    end
+    pair.compact
+  end
+end
+class DateTime
+  include DateTimeAgoInWords
 end

data/test/devlog_test.rb

@@ -123,4 +123,21 @@ class DevlogTest < Test::Unit::TestCase
 		load_devlog_stat
 		assert(@tajm_stat.devlog_sessions.size==8, "should be 8, but is #{@tajm_stat.devlog_sessions.size}")
 	end
+
+	def test_negative_sessions
+		load_devlog_negative
+		assert(@tajm_negative.devlog_sessions.size==5, "should be 5, but is #{@tajm_negative.devlog_sessions.size}")
+		shortest_session_time_rounded = @tajm_negative.shortest_session.session_time.round(2)
+		assert(shortest_session_time_rounded==-2, "should be -2.0, but is #{shortest_session_time_rounded}")
+		assert(@tajm_negative.negative_sessions.size==2, "should be 2, but is #{@tajm_negative.negative_sessions.size}")
+	end
+
+	def test_zero_sessions
+		load_devlog_negative
+		assert(@tajm_negative.devlog_sessions.size==5, "should be 5, but is #{@tajm_negative.devlog_sessions.size}")
+		zero_session_time_rounded = @tajm_negative.zero_sessions.first.session_time.round(2)
+		assert(zero_session_time_rounded==0.0, "should be 0.0, but is #{zero_session_time_rounded}")
+		assert(@tajm_negative.zero_sessions.size==1, "should be 1, but is #{@tajm_negative.zero_sessions.size}")
+	end
+
 end

data/test/test_helper.rb

@@ -39,4 +39,8 @@ end
 
 def load_devlog_single
 	@tajm_single = parse_devlog_now(File.join(File.dirname(__FILE__), '..', 'test_single_devlog.markdown'))
-end
+end
+
+def load_devlog_negative
+	@tajm_negative = parse_devlog_now(File.join(File.dirname(__FILE__), '..', 'test_negative_devlog.markdown'))
+end

data/test_negative_devlog.markdown

@@ -0,0 +1,31 @@
+#03.02.2014 16:20:03 CodingSession::END
+
+- 1 hour negative
+
+#03.02.2014 17:20:03 CodingSession::BEGIN
+
+
+#02.02.2014 17:20:03 CodingSession::END
+
+1 hour positive
+
+#02.02.2014 16:20:03 CodingSession::BEGIN
+
+
+#02.02.2014 08:10:10 ComSession::END
+
+-2 hours negative session
+
+#02.02.2014 10:10:10 ComSession::BEGIN
+
+#01.01.2014 20:21:20 CodingSession::END
+
+0 session
+
+#01.01.2014 20:21:20 CodingSession::BEGIN
+
+#01.01.2014 20:20:20 CodingSession::END
+
+1 hour positive session
+
+#01.01.2014 16:20:20 CodingSession::BEGIN

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devlog
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - mihael
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
@@ -74,6 +74,7 @@ files:
 - test/devlog_test.rb
 - test/test_helper.rb
 - test_devlog.markdown
+- test_negative_devlog.markdown
 - test_single_devlog.markdown
 - test_stats_devlog.markdown
 homepage: http://github.com/mihael/devlog
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: takes devlog.markdown and gives info