logbook-ruby 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4bf9e794073c670236e9601796efb0ac9260d2825f409034b3f246dbe65cb4b6
-  data.tar.gz: 88bd820e0f1d5a07fccb6a75161c9d1e751d3d582ed3574ebaa5bdba983da17f
+SHA1:
+  metadata.gz: 33922c3808312335aa817342c0057f110fa07d4f
+  data.tar.gz: cbe8daaf3b9811df06e7846fbbc0f879f0c8e573
 SHA512:
-  metadata.gz: 0f053d6ec96f78f6214449425e7e89d6f22f35095af529ea499d04ad261498cf52301b721b9a37812aba42e4c2071c49753232fbfc2eba0862508baa308d0e71
-  data.tar.gz: 7a9a11bc868752d1f3e50f59f0b5b99ec9b510f729710c85600f99b810cb490062e0bd2782d7828e32e8ad3f3ad0747c41d916a4aae2df2768de419f3c5d3d30
+  metadata.gz: 7c0e74d9d25e2cf64b288b6485213fb3eccd236e6db5073ab39c6e8ef57eb9040616431e359c331366ef8518bd032a2c4bd60a17abbe41f5b5232dbcb2288429
+  data.tar.gz: 83dfb63517c4597bed2a636e4cc53179f9d15cc34272cf2abfaf9fcbc02619797113c8eebed2a91a09aff7a5358951914ad3bc94d330b076251df413d4a18438

data/.tool-versions

@@ -1 +1 @@
-ruby 2.5.0
+ruby 2.4.1

data/lib/logbook.rb

@@ -1,15 +1,19 @@
 module Logbook
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 
   require "logbook/builder"
+  require "logbook/clock"
+  require "logbook/log_entry"
   require "logbook/page"
   require "logbook/parser"
-  require "logbook/log_entry"
+  require "logbook/property"
   require "logbook/task"
   require "logbook/task_definition"
   require "logbook/task_entry"
 
-  Duration = Struct.new(:minutes)
-  Property = Struct.new(:name, :value)
-  Tag = Struct.new(:value)
+  Duration = Struct.new(:minutes) do
+    def +(other_duration)
+      Duration.new(self.minutes + other_duration.minutes)
+    end
+  end
 end

data/lib/logbook/builder.rb

@@ -2,7 +2,7 @@ require "parslet"
 
 module Logbook
   class Builder < Parslet::Transform
-    rule(tag: simple(:tag)) { Tag.new(tag.to_s) }
+    rule(tag: simple(:tag)) { Property.new(tag.to_s) }
 
     rule(property: {name: simple(:name), value: simple(:value)}) do
       Property.new(name.to_s, value.to_s)
@@ -16,21 +16,19 @@ module Logbook
     end
 
     rule(task_definition: subtree(:task)) do
-      properties =  task[:properties].select { |item| item.instance_of?(Property) }.map { |property| [property.name, property.value] }.to_h
-      tags =  task[:properties].select { |item| item.instance_of?(Tag) }
+      properties =  task[:properties].map { |property| [property.name, property] }.to_h
       line_number, _ = task[:status].line_and_column
       note = task[:note].to_s.strip.chomp
 
-      TaskDefinition.new(line_number, task[:title].to_s, task[:status].to_s, properties, tags, note)
+      TaskDefinition.new(line_number, task[:title].to_s, task[:status].to_s, properties, note)
     end
 
     rule(task_entry: subtree(:task)) do
-      properties =  task[:properties].select { |item| item.instance_of?(Property) }.map { |property| [property.name, property.value] }.to_h
-      tags =  task[:properties].select { |item| item.instance_of?(Tag) }
+      properties =  task[:properties].map { |property| [property.name, property] }.to_h
       line_number, _ = task[:status].line_and_column
       note = task[:note].to_s.strip.chomp
 
-      TaskEntry.new(line_number, task[:time].to_s, task[:title].to_s, task[:status].to_s, properties, tags, note)
+      TaskEntry.new(line_number, task[:time].to_s, task[:title].to_s, task[:status].to_s, properties, note)
     end
 
     def self.build(contents)
@@ -40,7 +38,7 @@ module Logbook
       logbook_page = entries_and_properties.inject(Page.new) do |page, entry_or_property|
         case entry_or_property
         when Property
-          current_properties[entry_or_property.name] = entry_or_property.value
+          current_properties[entry_or_property.name] = entry_or_property
           page
         when TaskDefinition, TaskEntry
           entry_or_property.merge_page_properties(current_properties)

data/lib/logbook/clock.rb

@@ -0,0 +1,43 @@
+module Logbook
+  class Clock
+    def tick(entry)
+      case entry
+      when LogEntry
+        if running?
+          yield(tracked_entry, minutes_in_between(tracked_entry, entry))
+          reset
+        end
+      when TaskEntry
+        if running?
+          yield(tracked_entry, minutes_in_between(tracked_entry, entry))
+          reset
+        end
+
+        if entry.starts_clock?
+          track(entry)
+        end
+      else
+        # ignore
+      end
+    end
+
+    private
+    attr_accessor :tracked_entry
+
+    def reset
+      @tracked_entry = nil
+    end
+
+    def running?
+      !tracked_entry.nil?
+    end
+
+    def track(entry)
+      @tracked_entry = entry
+    end
+
+    def minutes_in_between(previous_entry, current_entry)
+      Duration.new((current_entry.recorded_at.to_time - previous_entry.recorded_at.to_time) / 60)
+    end
+  end
+end

data/lib/logbook/log_entry.rb

@@ -5,19 +5,11 @@ module Logbook
     attr_accessor :properties
 
     def recorded_at
-      date = self.properties[DATE_PROPERTY_NAME]
+      date = self.properties[DATE_PROPERTY_NAME].value
       time = self.time
 
       DateTime.parse(date + " " + time)
     rescue ArgumentError
     end
-
-    def starts_clock?
-      false
-    end
-
-    def stops_clock?
-      true
-    end
   end
 end

data/lib/logbook/page.rb

@@ -1,39 +1,44 @@
 module Logbook
   class Page
-    attr_accessor :entries, :properties
+    attr_accessor :clock, :entries, :logged_work, :properties
 
     def initialize
+      @clock = Clock.new
       @entries = []
+      @logged_work = {}
     end
 
     def add(entry)
       entries << entry
+      clock.tick(entry) { |tracked_entry, duration| logged_work.store(tracked_entry, duration) }
     end
 
     def entry_at(line_number)
       entries.reverse.find { |entry| entry.line_number <= line_number }
     end
 
-    def total_duration
-      _, duration = entries.inject([nil, Duration.new(0)]) do |(previous_entry, duration), current_entry|
-        if previous_entry && previous_entry.starts_clock?
-          if current_entry.stops_clock?
-            new_duration = Duration.new(duration.minutes + minutes_in_between(previous_entry, current_entry))
-            [current_entry, new_duration]
-          else
-            [previous_entry, duration]
+    def logged_time
+      logged_work.map { |entry, duration| duration }.reduce(Duration.new(0), &:+)
+    end
+
+    def tasks
+      entries.reduce({}) do |tasks, entry|
+        case entry
+        when TaskEntry, TaskDefinition
+          if entry.belongs_to_task?
+            task = tasks[entry.task_id] ||= Task.new(entry.task_id)
+
+            if logged_work.has_key?(entry)
+              task.log_work(entry, logged_work[entry])
+            else
+              task.add_entry(entry)
+            end
           end
         else
-          [current_entry, duration]
         end
-      end
 
-      duration
-    end
-
-    private
-    def minutes_in_between(previous_entry, current_entry)
-      (current_entry.recorded_at.to_time - previous_entry.recorded_at.to_time) / 60
+        tasks
+      end
     end
   end
 end

data/lib/logbook/parser.rb

@@ -7,7 +7,8 @@ module Logbook
     rule(:newline) { match("\n") }
 
     rule(:text) { match("[^\n]") }
-    rule(:text_line) { text.repeat(0) >> newline }
+    rule(:text_line) { text.repeat(1) }
+    rule(:text_line_with_newline) { text.repeat(0) >> newline }
     rule(:label) { match["a-zA-Z"] >> match["a-zA-Z0-9_-"].repeat }
 
     rule(:property_value) { match("[^\\n\\]\\[]").repeat(1) }
@@ -27,19 +28,19 @@ module Logbook
     rule(:status) { str("[") >> label.as(:status) >> str("]") }
     rule(:title) { text.repeat }
 
-    rule(:note_line) { time.absent? >> status.absent? >> property.absent? >> text_line }
+    rule(:note_line) { time.absent? >> status.absent? >> property.absent? >> (text_line_with_newline | text_line)}
     rule(:note) { note_line.repeat }
 
     rule(:log_entry) { time >> whitespace >> newline.maybe >> note.as(:note) }
 
     rule(:task_definition) do
-      status >> whitespace >> title.as(:title) >> str("\n") >>
+      status >> whitespace >> title.as(:title) >> newline >>
       newline.repeat >> property_or_tag_list.as(:properties) >>
       newline.repeat >> note.as(:note)
     end
 
     rule(:task_entry) do
-      time >> whitespace >> status >> whitespace >> title.as(:title) >> str("\n") >>
+      time >> whitespace >> status >> whitespace >> title.as(:title) >> newline >>
       newline.repeat >> property_or_tag_list.as(:properties) >>
       newline.repeat >> note.as(:note)
     end
@@ -50,7 +51,7 @@ module Logbook
         task_entry.as(:task_entry) |
         log_entry.as(:log_entry) |
         property.as(:property) |
-        text_line
+        (text_line_with_newline | text_line)
       ).repeat
     end
 

data/lib/logbook/property.rb

@@ -0,0 +1,20 @@
+module Logbook
+  class Property
+    attr_accessor :name, :value
+
+    TAG_VALUE = nil
+
+    def initialize(name, value = TAG_VALUE)
+      @name = name
+      @value = value
+    end
+
+    def has_value?
+      !is_tag? && !value.strip.empty?
+    end
+
+    def is_tag?
+      self.value === TAG_VALUE
+    end
+  end
+end

data/lib/logbook/task.rb

@@ -1,9 +1,31 @@
 module Logbook
   class Task
+    attr_accessor :entries, :id, :properties, :status, :title, :time_logged
+
     DONE = "Done"
     PAUSE = "Pause"
     REOPEN = "Reopen"
     RESUME = "Resume"
     START = "Start"
+    TASK_ID_PROPERTY = "ID"
+
+    def initialize(id)
+      @entries = []
+      @id = id
+      @properties = {}
+      @time_logged = Duration.new(0)
+    end
+
+    def add_entry(entry)
+      self.properties.merge!(entry.properties)
+      self.status = entry.status
+      self.title = entry.title
+    end
+
+    def log_work(entry, duration)
+      add_entry(entry)
+
+      self.time_logged += duration
+    end
   end
 end

data/lib/logbook/task_definition.rb

@@ -1,15 +1,16 @@
 module Logbook
-  class TaskDefinition < Struct.new(:line_number, :title, :status, :properties, :tags, :note)
-    def merge_page_properties(properties)
-      self.properties = properties.merge(self.properties)
+  class TaskDefinition < Struct.new(:line_number, :title, :status, :properties, :note)
+    def belongs_to_task?
+      self.properties.has_key?(Task::TASK_ID_PROPERTY) &&
+        self.properties[Task::TASK_ID_PROPERTY].has_value?
     end
 
-    def starts_clock?
-      false
+    def merge_page_properties(properties)
+      self.properties = properties.merge(self.properties)
     end
 
-    def stops_clock?
-      false
+    def task_id
+      self.properties[Task::TASK_ID_PROPERTY].value
     end
   end
 end

data/lib/logbook/task_entry.rb

@@ -1,15 +1,20 @@
 require "date"
 
 module Logbook
-  class TaskEntry < Struct.new(:line_number, :time, :title, :status, :properties, :tags, :note)
+  class TaskEntry < Struct.new(:line_number, :time, :title, :status, :properties, :note)
     DATE_PROPERTY_NAME = "Date"
 
+    def belongs_to_task?
+      self.properties.has_key?(Task::TASK_ID_PROPERTY) &&
+        self.properties[Task::TASK_ID_PROPERTY].has_value?
+    end
+
     def merge_page_properties(properties)
       self.properties = properties.merge(self.properties)
     end
 
     def recorded_at
-      date = self.properties[DATE_PROPERTY_NAME]
+      date = self.properties[DATE_PROPERTY_NAME].value
       time = self.time
 
       DateTime.parse(date + " " + time)
@@ -20,8 +25,8 @@ module Logbook
       [Task::START, Task::RESUME, Task::REOPEN].include?(self.status)
     end
 
-    def stops_clock?
-      true
+    def task_id
+      self.properties[Task::TASK_ID_PROPERTY].value
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logbook-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Gabriel Malkas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,9 +114,11 @@ files:
 - bin/setup
 - lib/logbook.rb
 - lib/logbook/builder.rb
+- lib/logbook/clock.rb
 - lib/logbook/log_entry.rb
 - lib/logbook/page.rb
 - lib/logbook/parser.rb
+- lib/logbook/property.rb
 - lib/logbook/task.rb
 - lib/logbook/task_definition.rb
 - lib/logbook/task_entry.rb
@@ -140,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby library for the Logbook file format