tempo-cli 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1e31cb5d21c90343bf98498d67ece6b53532fe
-  data.tar.gz: 22380af6098cebe55438b9878a5324f4024d414b
+  metadata.gz: 59fac2395c13e4a0a58701053e5ed9696146bb44
+  data.tar.gz: 42df9a9ed12b2a50771cd0b9e64500f346bacef7
 SHA512:
-  metadata.gz: 4cd63f381d1b7267e0951a2aa3f709fffadc25db098c7581e929254c28fe36ca334c849243b79d22e407ea41c582f642d44ad4784617b01373ba5fb535e77507
-  data.tar.gz: 64038cd234cecf689e3f48c20719de6d1c9843c87952570bb73ffb74c70eaea4a4548ba2532e813ff087d5ad5bbe1722e3f919dbb17ca8decfe2ea584b3b6dad
+  metadata.gz: 26a42ed193477f0dde232ef0209d70899d1fdc1b338e27779c5714d73f1f6b8499db8d1de0f0f81955783067f97ed2b533d336f61aafd3f11a016a18a3fa26d5
+  data.tar.gz: 77f7093821bd7a097f7cc7df90a7ea4426ff81acf10c776e3799af78a2ec6315744a82eb4e5ffedc7c556d76a32ea65c55bc64096afcfaaff8d5581e5db50d84

data/bin/tempo

@@ -377,6 +377,11 @@ command [:report, :r] do |c|
   c.default_value 'today'
   c.flag [:t, :to]
 
+  c.desc 'order reports by date or project'
+  c.arg_name '[project, date]'
+  c.default_value 'date'
+  c.flag [:o, :order]
+
   c.action do |global_options, options, args|
     controller = Tempo::Controllers::Report
 

data/lib/tempo/controllers/report_controller.rb

@@ -47,7 +47,7 @@ module Tempo
 
           return Views.no_items( "time records#{error_timeframe}", :error ) if @time_records.index.empty?
 
-          Views.report_records_view
+          Views.report_records_view options
         end
       end #class << self
     end

data/lib/tempo/controllers/update_controller.rb

@@ -43,7 +43,9 @@ module Tempo
             record = @time_records.find_by_id( options[:id], day )
             return Views.no_match_error( "time record on #{day.strftime('%m/%d/%Y')}", "id = #{options[:id]}", false ) if !record
           else
-            record = @time_records.index.last
+            # TODO: this will still not pick the days last entry
+            # by time if ids are out of order and none are running.
+            record = @time_records.current || @time_records.index.last
             return Views.no_items( "time records on #{day.strftime('%m/%d/%Y')}", :error ) if ! record
           end
 
@@ -66,7 +68,6 @@ module Tempo
             if options[:start]
               start_time = Time.parse options[:start]
               return Views.no_match_error( "valid timeframe", options[:at], false ) if start_time.nil?
-
               if record.valid_start_time? start_time
                 record.start_time = start_time
 

data/lib/tempo/version.rb

@@ -1,3 +1,3 @@
 module Tempo
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/lib/tempo/views/base.rb

@@ -22,10 +22,15 @@ module Tempo
             view_opts[:tags] = options[:tag] || options[:untag] ? true : false
             view_opts[:id] = global_options[:id] || options[:id] ? true : false
           end
+        when :report, :r
+          if /^p(roject)?$/.match(options[:order]) && ! global_options[:verbose]
+            view_opts[:bullet_report] = true
+          end
         end
         Tempo::Views::Reporter.add_options view_opts
       end
 
+      # called in the preblock when verbose = true
       def options_report(command, global_options, options, args)
         globals_list = "global options: "
         global_options.each {|k,v| globals_list += "#{k} = #{v}, " if k.kind_of? String and k.length > 1 and !v.nil? }

data/lib/tempo/views/formatters/base.rb

@@ -13,16 +13,38 @@ module Tempo
 
       class Base
 
+        def initialize(options={})
+          @options = options
+        end
+
+        def report(record)
+          class_block = "#{record.type}_block"
+
+          # We handle containers separately
+          if /container/.match class_block
+            format_records_container(record)
+          else
+            send(class_block, record) if respond_to? class_block
+          end
+        end
+
         # Here we check if our class methods include a proc block to handle the particular
         # record type.  See View Records for all possible record types.  See screen formatter
         # for examples of proc blocks.
         #
-        def format_records(records, options={})
-          @options = options
+        def format_records(records)
           records.each do |record|
-            class_block = "#{record.type}_block"
-            send( class_block, record ) if respond_to? class_block
+            report record
+          end
+        end
+
+        # Records containers handle nested records
+        def format_records_container(container)
+          report container.pre if container.pre
+          container.records.each do |record|
+            report record
           end
+          report container.post if container.post
         end
       end
     end

data/lib/tempo/views/formatters/screen.rb

@@ -31,6 +31,8 @@ module Tempo
           end
         end
 
+# PARTIALS --------------------------------------------------------------------/
+
         # spacer for project titles, active project marked with *
         def active_indicator(project)
           indicator = project.current ? "* " : "  "
@@ -54,6 +56,9 @@ module Tempo
           @options[:id] ? "[#{id}] ".rjust(6, ' ') : ""
         end
 
+# PARTIALS --------------------------------------------------------------------/
+
+
         def project_block(record)
 
           record.format do |r|
@@ -72,11 +77,16 @@ module Tempo
         end
 
         def timerecord_block(record)
+          #require 'pry'; binding.pry
           record.format do |r|
             id = id_partial r.id
             running = r.running ? "*" : " "
-            description = r.description.empty? ? "#{r.project}" : "#{r.project}: #{r.description}"
-            view =  "#{id}#{r.start_time.strftime('%H:%M')} - #{r.end_time.strftime('%H:%M')}#{running} [#{r.duration.format}] #{description}"
+            if @options[:bullet_report]
+              view =  " * #{r.description}"
+            else
+              description = r.description.empty? ? "#{r.project}" : "#{r.project}: #{r.description}"
+              view =  "#{id}#{r.start_time.strftime('%H:%M')} - #{r.end_time.strftime('%H:%M')}#{running} [#{r.duration.format}] #{description}"
+            end
             puts view
           end
         end

data/lib/tempo/views/report_view.rb

@@ -4,20 +4,59 @@ module Tempo
 
       def report_records_view(options={})
 
+        # Haven't we already checked for this?
         projects = options.fetch(:projects, Tempo::Model::Project.index)
         return no_items("projects") if projects.empty?
 
+        # TODO: Document here days index structure, give example of sending in subsets
+        # so the Records Controller can manage the organization of the records.
         time_records = options.fetch( :time_records, Tempo::Model::TimeRecord.days_index )
+
+        # It this going to break if 1 of X record containers is empty?
+        # Or should the controller not send empty records and this is good to check for?
+        # Maybe No time records for <date>?
         return no_items("time records") if time_records.empty?
 
+        if options[:order] == "date" || options[:order] == "d"
+          order_by_date time_records
+        elsif options[:order] == "project" || options[:order] == "p"
+          order_by_project projects, time_records
+        else
+          return error "Unable to report time records sorted by '#{options[:order]}'"
+        end
+      end
+
+    private
+
+      def order_by_date(time_records)
         time_records.each do |d_id, days_record|
 
           day = Tempo::Model::TimeRecord.day_id_to_time d_id
-          ViewRecords::Message.new ""
-          ViewRecords::Message.new day.strftime("Records for %m/%d/%Y:")
+
+          container = ViewRecords::TimeRecordContainer.new
+          container.pre = ViewRecords::Message.new day.strftime("Records for %m/%d/%Y:\n\n"), postpone: true
 
           days_record.each do |time_record|
-            time_record_view time_record
+            container.add(time_record_view time_record, postpone: true)
+          end
+        end
+      end
+
+      def order_by_project(projects, time_records)
+        project_records = Hash.new {|this_hash, nonexistent_key| this_hash[nonexistent_key] = [] }
+        time_records.each do |d_id, days_records|
+          days_records.each do |days_record|
+            # TODO: if project in projects (for filtering)
+            project_records[days_record.project] << days_record
+          end
+        end
+
+        project_records.each do |pr,time_records|
+          container = ViewRecords::TimeRecordContainer.new
+          #require 'pry'; binding.pry
+          container.pre = ViewRecords::Message.new "Records for #{Model::Project.find_by_id(pr).title}\n", postpone: true
+          time_records.each do |time_record|
+            container.add(time_record_view time_record, postpone: true)
           end
         end
       end

data/lib/tempo/views/reporter.rb

@@ -61,8 +61,8 @@ module Tempo
 
         def report
           # TODO send records to added formatters
-          screen_formatter = Formatters::Screen.new
-          screen_formatter.format_records view_records, options
+          screen_formatter = Formatters::Screen.new(options)
+          screen_formatter.format_records view_records
         end
       end
     end

data/lib/tempo/views/time_record_view.rb

@@ -2,8 +2,9 @@ module Tempo
   module Views
     class << self
 
-      def time_record_view(time_record)
-        ViewRecords::TimeRecord.new time_record
+      # Container sends postpone: true through options
+      def time_record_view(time_record, options={})
+        ViewRecords::TimeRecord.new time_record, options
       end
 
       def start_time_record_view(time_record)

data/lib/tempo/views/view_records/base.rb

@@ -27,6 +27,9 @@ module Tempo
       # category :error will raise an error after all viewRecords
       # have been run through the reporters
       #
+      # Containers send :pospone => true in options in order to manage
+      # triggering the message themselves
+      #
       class Message
         attr_accessor :type, :message, :category
 
@@ -34,7 +37,7 @@ module Tempo
           @message = message
           @category = options.fetch( :category, :info )
           @type = "message"
-          Reporter.add_view_record self
+          Reporter.add_view_record self unless options[:postpone]
         end
 
         def format(&block)
@@ -93,6 +96,9 @@ module Tempo
       # tempo model without error, but most likely won't be as useful as a child class
       # taylored to the specifics of the actual model's child class.
       #
+      # Containers send :pospone => true in options in order to manage
+      # triggering the message themselves
+      #
       class Model
         attr_accessor :id, :type
 
@@ -101,7 +107,7 @@ module Tempo
 
           # example: Tempo::Model::Something => "something"
           @type = /Tempo::Model::(.*)$/.match( model.class.to_s )[1].downcase
-          Reporter.add_view_record self
+          Reporter.add_view_record self unless options[:postpone]
         end
 
         def format(&block)

data/lib/tempo/views/view_records/container.rb

@@ -0,0 +1,68 @@
+# Wrapper object for ViewRecords, able to collect multiple viewrecords
+# this allows for a begining and end record, collecting total duration, etc.
+
+# @pre = Optional record which is sent to the formatter before the collection
+# @post = Optionsal record which is sent to the formatter after the collection
+module Tempo
+  module Views
+    module ViewRecords
+
+      class Container
+        attr_accessor :type, :pre, :post
+
+        def initialize(options={})
+          # TODO: add error checking for pre and post, better handling nil values
+          @pre = options.fetch( :pre, nil )
+          @post = options.fetch( :post, nil )
+          @type = "container"
+          @collection = [] # handle records on init?
+          Reporter.add_view_record self unless options[:postpone]
+        end
+
+        # add a splat?
+        def add(record)
+          @collection << record
+        end
+
+        #TODO: Implement pre and post method with logic to handle both
+        #      views reocrds and strings. See post in TimeRecordContainer
+        #      for use case
+
+        def records
+          @collection
+        end
+      end
+    end
+  end
+end
+
+
+module Tempo
+  module Views
+    module ViewRecords
+
+      # Handle a collection of time records
+      # Pre can hold the title of the collection (date, project, etc.)
+      # postreturns the total duration of all contained records
+      class TimeRecordContainer < ViewRecords::Container
+        attr_accessor :duration
+
+        def initialize(options={})
+          super options
+          @type = "time_record_container"
+          @duration = Duration.new
+        end
+
+        def add(record)
+          # TODO: fail if not a time record
+          super record
+          @duration.add record.duration.total
+        end
+
+        def post
+          ViewRecords::Message.new "Total: ------- [#{duration.format}] --------------------------------\n\n", postpone: true
+        end
+      end
+    end
+  end
+end

data/test/lib/tempo/views/formatters/screen_test.rb

@@ -7,20 +7,21 @@ describe Tempo do
 
         before do
           view_records_factory
-          @formatter = Tempo::Views::Formatters::Screen.new
         end
 
         describe "Message View Records" do
 
           it "outputs the message" do
             records = [@message_1, @message_2]
-            out = capture_stdout { @formatter.format_records records }
+            formatter = Tempo::Views::Formatters::Screen.new
+            out = capture_stdout { formatter.format_records records }
 
             assert_equal "All The Things I Did\non a busy busy day\n", out.string
           end
 
           it "raises an error when type error" do
-            proc { @formatter.format_records [@error] }.must_raise RuntimeError
+            formatter = Tempo::Views::Formatters::Screen.new
+            proc { formatter.format_records [@error] }.must_raise RuntimeError
           end
         end
 
@@ -28,7 +29,8 @@ describe Tempo do
 
           it "outputs the duration" do
             records = [@duration]
-            out = capture_stdout { @formatter.format_records records }
+            formatter = Tempo::Views::Formatters::Screen.new
+            out = capture_stdout { formatter.format_records records }
 
             assert_equal "2:40\n", out.string
           end
@@ -38,14 +40,16 @@ describe Tempo do
 
           it "outputs the project title" do
             records = [@project_1]
-            out = capture_stdout { @formatter.format_records records }
+            formatter = Tempo::Views::Formatters::Screen.new
+            out = capture_stdout { formatter.format_records records }
 
             assert_equal "sheep herding\n", out.string
           end
 
           it "accepts option to include tags with spacing" do
             records = [@project_1, @project_2]
-            out = capture_stdout { @formatter.format_records records, { tags: true }}
+            formatter = Tempo::Views::Formatters::Screen.new tags: true
+            out = capture_stdout { formatter.format_records records }
 
             assert_equal "sheep herding                      tags: none\n" +
                          "horticulture - basement mushrooms  tags: [farming, fungi]\n", out.string
@@ -53,7 +57,8 @@ describe Tempo do
 
           it "accepts option to include id" do
             records = [@project_2]
-            out = capture_stdout { @formatter.format_records records, { id: true }}
+            formatter = Tempo::Views::Formatters::Screen.new id: true
+            out = capture_stdout { formatter.format_records records }
 
             assert_equal "  [2] horticulture - basement mushrooms\n", out.string
           end
@@ -61,14 +66,16 @@ describe Tempo do
           it "accepts option to indent projects to proper depth" do
             @project_1.depth = 3
             records = [@project_1]
-            out = capture_stdout { @formatter.format_records records, { depth: true }}
+            formatter = Tempo::Views::Formatters::Screen.new depth: true
+            out = capture_stdout { formatter.format_records records}
 
             assert_equal "      sheep herding\n", out.string
           end
 
           it "indicates active project" do
             records = [@project_1, @project_2]
-            out = capture_stdout { @formatter.format_records records, {active: true}}
+            formatter = Tempo::Views::Formatters::Screen.new active: true
+            out = capture_stdout { formatter.format_records records }
             assert_equal "  sheep herding\n* horticulture - basement mushrooms\n", out.string
           end
         end
@@ -76,14 +83,16 @@ describe Tempo do
         describe "TimeRecord View Records" do
           it "has start/end time, duration, project and description" do
             records = [@time_record_1]
-            out = capture_stdout { @formatter.format_records records }
+            formatter = Tempo::Views::Formatters::Screen.new
+            out = capture_stdout { formatter.format_records records }
 
             assert_equal "07:00 - 07:30  [0:30] sheep herding: day 1 pet the sheep\n", out.string
           end
 
           it "outputs a running indicator" do
             records = [@time_record_6]
-            out = capture_stdout { @formatter.format_records records }
+            formatter = Tempo::Views::Formatters::Screen.new
+            out = capture_stdout { formatter.format_records records }
 
             assert_match /17:00 - \d{2}:\d{2}\*/, out.string
           end

data/test/lib/tempo/views/view_records/base_test.rb

@@ -26,6 +26,12 @@ describe Tempo do
           record = Tempo::Views::ViewRecords::Message.new "a message view record"
           Tempo::Views::Reporter.view_records.length.must_equal length_before + 1
         end
+
+        it "doesn't add itself with options postpone" do
+          length_before = Tempo::Views::Reporter.view_records.length
+          record = Tempo::Views::ViewRecords::Message.new "a message view record", postpone: true
+          Tempo::Views::Reporter.view_records.length.must_equal length_before
+        end
       end
 
       describe "Duration" do
@@ -74,4 +80,4 @@ describe Tempo do
       end
     end
   end
-end
+end

data/test/lib/tempo/views/view_records/container_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "ViewRecords" do
+
+      describe "Container" do
+
+        it "has a type, pre,and post attribute" do
+          pre = Tempo::Views::ViewRecords::Message.new "pre message"
+          post = Tempo::Views::ViewRecords::Message.new "post message"
+          container = Tempo::Views::ViewRecords::Container.new pre: pre, post: post
+          container.type.must_equal "container"
+          container.pre.message.must_equal "pre message"
+          container.post.message.must_equal "post message"
+        end
+
+        it "has adds and contains a collection of view records" do
+          container = Tempo::Views::ViewRecords::Container.new
+          m1 = Tempo::Views::ViewRecords::Message.new "first message", postpone: true
+          m2 = Tempo::Views::ViewRecords::Message.new "second message", postpone: true
+          m3 = Tempo::Views::ViewRecords::Message.new "third message", postpone: true
+          [m1, m2, m3].each { |m| container.add m }
+          container.records.must_equal [m1,m2,m3]
+        end
+
+        it "adds itself to the Reporter" do
+          length_before = Tempo::Views::Reporter.view_records.length
+          record = Tempo::Views::ViewRecords::Container.new
+          Tempo::Views::Reporter.view_records.length.must_equal length_before + 1
+        end
+
+        it "doesn't add itself with options postpone" do
+          length_before = Tempo::Views::Reporter.view_records.length
+          record = Tempo::Views::ViewRecords::Message.new "a message view record", postpone: true
+          Tempo::Views::Reporter.view_records.length.must_equal length_before
+        end
+      end
+
+      describe "TimeRecordContainer" do
+        # TODO: Write ViewRecord Time Record tests first
+        # then add time records to a time records container
+        # test the total time is accurate
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tempo-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Jonathan Gabel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,6 +165,7 @@ files:
 - lib/tempo/views/time_record_view.rb
 - lib/tempo/views/view_records/base.rb
 - lib/tempo/views/view_records/composite.rb
+- lib/tempo/views/view_records/container.rb
 - lib/tempo/views/view_records/log.rb
 - lib/tempo/views/view_records/project.rb
 - lib/tempo/views/view_records/time_record.rb
@@ -186,6 +187,7 @@ files:
 - test/lib/tempo/views/reporter_test.rb
 - test/lib/tempo/views/view_records/base_test.rb
 - test/lib/tempo/views/view_records/composite_test.rb
+- test/lib/tempo/views/view_records/container_test.rb
 - test/lib/tempo/views/view_records/log_test.rb
 - test/lib/tempo/views/view_records/project_test.rb
 - test/lib/tempo/views/view_records/time_record_test.rb