tempo-cli 0.1.0

data/test/lib/tempo/models/time_record_test.rb

@@ -0,0 +1,212 @@
+require "test_helper"
+
+describe Tempo do
+
+  before do
+    # See Rakefile for directory prep and cleanup
+    @dir = File.join( Dir.home,"tempo" )
+    Dir.mkdir(@dir, 0700) unless File.exists?(@dir)
+  end
+
+  after do
+    FileUtils.rm_r(@dir) if File.exists?(@dir)
+  end
+
+  describe "Model::TimeRecord" do
+
+    it "has project as an accessible attribute" do
+      time_record_factory
+      has_attr_accessor?( @record_1, :description ).must_equal true
+    end
+
+    it "defaults to the current project" do
+      project_factory
+      Tempo::Model::TimeRecord.clear_all
+      @record_1 = Tempo::Model::TimeRecord.new({ description: "day 1 pet the sheep",
+                                                 start_time: Time.new(2014, 1, 1, 7 ) })
+      @record_1.project.must_equal Tempo::Model::Project.current.id
+    end
+
+    it "has an accessible description" do
+      time_record_factory
+      has_attr_accessor?( @record_1, :description ).must_equal true
+    end
+
+    it "has a readable end time" do
+      time_record_factory
+      has_attr_reader?( @record_1, :end_time ).must_equal true
+    end
+
+    it "has readable tags" do
+      time_record_factory
+      has_attr_read_only?( @record_1, :tags ).must_equal true
+    end
+
+    it "is taggable with an array of tags" do
+      time_record_factory
+      @record_2.tag(["fungi", "breakfast"])
+      @record_2.tags.must_equal(["breakfast", "fungi"])
+    end
+
+    it "is untaggable with an array of tags" do
+      time_record_factory
+      @record_3.untag( ["horticulture"] )
+      @record_3.tags.must_equal(["trees"])
+    end
+
+    it "has a current project getter" do
+      time_record_factory
+      Tempo::Model::TimeRecord.current.must_equal @record_6
+      @record_6.end_time.must_equal :running
+    end
+
+    it "closes current when adding an end time to current" do
+      time_record_factory
+      @record_6.end_time = Time.new(2014, 1, 2, 19, 00 )
+      Tempo::Model::TimeRecord.current.must_equal nil
+    end
+
+    it "has a running? method" do
+      time_record_factory
+      @record_1.running?.must_equal false
+      @record_6.running?.must_equal true
+    end
+
+    it "has a duration method returning seconds" do
+      time_record_factory
+      @record_1.duration.must_equal 1800
+      @record_6.duration.must_be_kind_of Integer
+    end
+
+    it "closes out the last current project on new" do
+      time_record_factory
+      @record_1.end_time.must_equal @record_2.start_time
+      @record_2.end_time.must_equal @record_3.start_time
+
+      @record_4.end_time.must_equal @record_5.start_time
+      @record_5.end_time.must_equal @record_6.start_time
+    end
+
+    it "closes projects on the start day" do
+      time_record_factory
+      @record_3.end_time.must_equal Time.new(2014,1,1,23,59)
+    end
+
+    it "closes out new projects if not the most recent" do
+      project_factory
+      Tempo::Model::TimeRecord.clear_all
+      @record_2 = Tempo::Model::TimeRecord.new({ project: @project_2, description: "day 1 drinking coffee, check on the mushrooms", start_time: Time.new(2014, 1, 1, 7, 30 ) })
+      @record_1 = Tempo::Model::TimeRecord.new({ project: @project_1, description: "day 1 pet the sheep", start_time: Time.new(2014, 1, 1, 7 ) })
+      Tempo::Model::TimeRecord.current.must_equal @record_2
+      @record_1.end_time.must_equal @record_2.start_time
+    end
+
+    it "closes out all projects when init with an end time" do
+      project_factory
+      Tempo::Model::TimeRecord.clear_all
+      @record_1 = Tempo::Model::TimeRecord.new({ project: @project_2, description: "day 1 drinking coffee, check on the mushrooms", start_time: Time.new(2014, 1, 1, 7, 30 ) })
+      @record_2 = Tempo::Model::TimeRecord.new({ project: @project_1, description: "day 1 pet the sheep", start_time: Time.new(2014, 1, 1, 8 ), end_time: Time.new(2014, 1, 1, 10 ) })
+      @record_1.end_time.must_equal @record_2.start_time
+      Tempo::Model::TimeRecord.current.must_equal nil
+    end
+
+    it "errors when start time inside existing record" do
+      time_record_factory
+      proc { Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 12 ) }) }.must_raise ArgumentError
+    end
+
+    it "errors when start time same as existing record" do
+      time_record_factory
+      proc { Tempo::Model::TimeRecord.new({ start_time: @record_1.start_time }) }.must_raise ArgumentError
+    end
+
+    it "errors when end time is before start time" do
+      Tempo::Model::TimeRecord.clear_all
+      proc { Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 12 ), end_time: Time.new(2014, 1, 1, 10 ) }) }.must_raise ArgumentError
+    end
+
+    it "accepts and end time equal to start time" do
+      Tempo::Model::TimeRecord.clear_all
+      record = Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 12 ), end_time: Time.new(2014, 1, 1, 12 ) })
+      record.end_time.must_equal record.start_time
+    end
+
+    it "end time can equal a previous start time" do
+      Tempo::Model::TimeRecord.clear_all
+      r1 = Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 10 ), end_time: Time.new(2014, 1, 1, 12 ) })
+      r2 = Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 8 ), end_time: Time.new(2014, 1, 1, 10 ) })
+      r1.start_time.must_equal r2.end_time
+    end
+
+    it "errors when end time is on a different day" do
+      Tempo::Model::TimeRecord.clear_all
+      proc { Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 10 ), end_time: Time.new(2014, 1, 2, 12 ) }) }.must_raise ArgumentError
+    end
+
+    it "errors when end time in existing record" do
+      Tempo::Model::TimeRecord.clear_all
+      r1 = Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 10 ), end_time: Time.new(2014, 1, 1, 12 ) })
+      proc { Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 8 ), end_time: Time.new(2014, 1, 1, 11 ) }) }.must_raise ArgumentError
+    end
+
+    it "errors when record spans an existing record" do
+      Tempo::Model::TimeRecord.clear_all
+      r1 = Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 10 ), end_time: Time.new(2014, 1, 1, 11 ) })
+      proc { Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 8 ), end_time: Time.new(2014, 1, 1, 12 ) }) }.must_raise ArgumentError
+    end
+
+    it "errors when record spans a running record" do
+      Tempo::Model::TimeRecord.clear_all
+      r1 = Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 10 ) })
+      proc { Tempo::Model::TimeRecord.new({ start_time: Time.new(2014, 1, 1, 8 ), end_time: Time.new(2014, 1, 1, 12 ) }) }.must_raise ArgumentError
+    end
+
+    it "has a valid start time check for existing record" do
+      time_record_factory
+      @record_2.valid_start_time?(@record_2.start_time).must_equal true
+      @record_2.valid_start_time?(@record_1.start_time).must_equal false
+    end
+
+    it "has a valid end time check for existing record" do
+      time_record_factory
+      @record_2.valid_end_time?(@record_2.end_time).must_equal true
+      @record_2.valid_end_time?(@record_3.end_time).must_equal false
+    end
+
+    it "comes with freeze dry for free" do
+      Tempo::Model::TimeRecord.clear_all
+      time_record_factory
+      @record_3.freeze_dry.must_equal({ :start_time=>Time.new(2014,1,1,17,30), :id=>3, :project=>3,
+                                        :end_time=>Time.new(2014,1,1,23,59), :description=>"day 1 water the bonsai",
+                                        :tags=>["horticulture", "trees"], :project_title=>"horticulture - backyard bonsai"})
+    end
+
+    it "saves to file a collection of projects" do
+      time_record_factory
+      Tempo::Model::TimeRecord.save_to_file
+      test_file_1 = File.join(ENV['HOME'],'tempo/tempo_time_records/20140101.yaml')
+      test_file_2 = File.join(ENV['HOME'],'tempo/tempo_time_records/20140102.yaml')
+      contents = eval_file_as_array( test_file_1 )
+      contents.must_equal [ "---", ":project_title: sheep herding", ":description: day 1 pet the sheep",
+                            ":start_time: 2014-01-01 07:00:00.000000000 -05:00", ":end_time: 2014-01-01 07:30:00.000000000 -05:00",
+                            ":id: 1", ":project: 1", ":tags: []",
+                            "---", ":project_title: horticulture - basement mushrooms", ":description: day 1 drinking coffee, check on the mushrooms",
+                            ":start_time: 2014-01-01 07:30:00.000000000 -05:00", ":end_time: 2014-01-01 17:30:00.000000000 -05:00",
+                            ":id: 2", ":project: 2", ":tags: []",
+                            "---", ":project_title: horticulture - backyard bonsai", ":description: day 1 water the bonsai",
+                            ":start_time: 2014-01-01 17:30:00.000000000 -05:00", ":end_time: 2014-01-01 23:59:00.000000000 -05:00",
+                            ":id: 3", ":project: 3", ":tags:", "- horticulture", "- trees"]
+      contents = eval_file_as_array( test_file_2 )
+      # TODO: test this one too when stable
+      contents.must_equal ["---", ":project_title: sheep herding", ":description: day 2 pet the sheep",
+                           ":start_time: 2014-01-02 07:15:00.000000000 -05:00", ":end_time: 2014-01-02 07:45:00.000000000 -05:00",
+                           ":id: 1", ":project: 1", ":tags: []",
+                           "---", ":project_title: horticulture - basement mushrooms", ":description: day 2 drinking coffee, check on the mushrooms",
+                           ":start_time: 2014-01-02 07:45:00.000000000 -05:00", ":end_time: 2014-01-02 17:00:00.000000000 -05:00",
+                           ":id: 2", ":project: 2", ":tags: []",
+                           "---", ":project_title: horticulture - backyard bonsai", ":description: day 2 water the bonsai",
+                           ":start_time: 2014-01-02 17:00:00.000000000 -05:00", ":end_time: :running",
+                           ":id: 3", ":project: 3", ":tags: []"]
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+
+    before do
+      project_factory
+      Tempo::Views::Reporter.clear_records
+    end
+
+    describe "project list view" do
+
+      it "adds projects to reporter by default" do
+        Tempo::Views::projects_list_view
+
+        view = []
+        Tempo::Views::Reporter.view_records.each {|r| view << r.title}
+        view.must_equal [ "gardening", "horticulture - backyard bonsai", "horticulture - basement mushrooms", "sheep herding" ]
+      end
+
+      it "should be able to return a subset of projects" do
+        subset = Tempo::Model::Project.index[1..3]
+        Tempo::Views::projects_list_view subset
+
+        view = []
+        Tempo::Views::Reporter.view_records.each {|r| view << r.title}
+        view.must_equal [ "gardening", "horticulture - backyard bonsai", "horticulture - basement mushrooms" ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "Formatters" do
+
+      describe "Base" do
+        # Base formatter is an abstract class. See child classes for
+        # testing the format_records method
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "Formatters" do
+      describe "Screen" 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 }
+
+            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
+          end
+        end
+
+        describe "Duration View Records" do
+
+          it "outputs the duration" do
+            records = [@duration]
+            out = capture_stdout { @formatter.format_records records }
+
+            assert_equal "2:40\n", out.string
+          end
+        end
+
+        describe "Project View Records" do
+
+          it "outputs the project title" do
+            records = [@project_1]
+            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 }}
+
+            assert_equal "sheep herding                      tags: none\n" +
+                         "horticulture - basement mushrooms  tags: [farming, fungi]\n", out.string
+          end
+
+          it "accepts option to include id" do
+            records = [@project_2]
+            out = capture_stdout { @formatter.format_records records, { id: true }}
+
+            assert_equal "  [2] horticulture - basement mushrooms\n", out.string
+          end
+
+          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 }}
+
+            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}}
+            assert_equal "  sheep herding\n* horticulture - basement mushrooms\n", out.string
+          end
+        end
+
+        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 }
+
+            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 }
+
+            assert_match /17:00 - \d{2}:\d{2}\*/, out.string
+          end
+        end
+      end
+    end
+  end
+end

data/test/lib/tempo/views/reporter_test.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "Reporter" do
+      it "adds and reports formats" do
+        Tempo::Views::Reporter.add_format :html, :json, :logs
+        Tempo::Views::Reporter.formats.must_equal [:html, :json, :logs]
+      end
+
+      it "collects view records as they are initialized" do
+        Tempo::Views::Reporter.clear_records
+        record_1 = Tempo::Views::ViewRecords::Message.new "a message to report"
+        record_2 = Tempo::Views::ViewRecords::Message.new "a second message to report"
+        record_3 = Tempo::Views::ViewRecords::Message.new "a third message to report"
+
+        Tempo::Views::Reporter.view_records.length.must_equal 3
+      end
+
+      it "raises and error when view records of unknown format" do
+        record = "an invalid record object"
+        proc { Tempo::Views::Reporter.add_view_record record }.must_raise Tempo::Views::InvalidViewRecordError
+      end
+
+      it "sends the reports to the screen formatter on report" do
+        Tempo::Views::Reporter.clear_records
+        record_1 = Tempo::Views::ViewRecords::Message.new "a message to report"
+
+        out = capture_stdout { Tempo::Views::Reporter.report }
+        assert_equal "a message to report\n", out.string
+      end
+
+      it "has a mutable collection of options" do
+        assert_equal Tempo::Views::Reporter.options, {}
+        Tempo::Views::Reporter.add_options({ tags: true, depth: 3, color: "red" })
+        assert_equal Tempo::Views::Reporter.options, { :tags=>true, :depth=>3, :color=>"red" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "ViewRecords" do
+
+      describe "Message" do
+
+        it "has a type, category,and message attribute" do
+          record = Tempo::Views::ViewRecords::Message.new "a message view record"
+          record.type.must_equal "message"
+          record.category.must_equal :info
+          record.message.must_equal "a message view record"
+
+          record = Tempo::Views::ViewRecords::Message.new "an error message", category: :error
+          record.category.must_equal :error
+        end
+
+        it "has a default format" do
+          record = Tempo::Views::ViewRecords::Message.new "a message view record"
+          record.format.must_equal "a message view record"
+        end
+
+        it "adds itself to the Reporter" do
+          length_before = Tempo::Views::Reporter.view_records.length
+          record = Tempo::Views::ViewRecords::Message.new "a message view record"
+          Tempo::Views::Reporter.view_records.length.must_equal length_before + 1
+        end
+      end
+
+      describe "Duration" do
+
+        it "has a type of duration" do
+          record = Tempo::Views::ViewRecords::Duration.new
+          record.type.must_equal "duration"
+        end
+
+        it "starts with given seconds or default to zero" do
+          record = Tempo::Views::ViewRecords::Duration.new
+          record.total.must_equal 0
+
+          record = Tempo::Views::ViewRecords::Duration.new 30
+          record.total.must_equal 30
+        end
+
+        it "has add and subtract methods" do
+          record = Tempo::Views::ViewRecords::Duration.new 30
+          record.add 160
+          record.total.must_equal 190
+          record.subtract 50
+          record.total.must_equal 140
+        end
+
+        it "has a default format" do
+
+          record = Tempo::Views::ViewRecords::Duration.new 1800
+          record.format.must_equal "0:30"
+
+          record = Tempo::Views::ViewRecords::Duration.new 18000
+          record.format.must_equal "5:00"
+
+          record = Tempo::Views::ViewRecords::Duration.new 36300
+          record.format.must_equal "10:05"
+
+          record = Tempo::Views::ViewRecords::Duration.new 39000
+          record.format.must_equal "10:50"
+        end
+
+        it "accepts a formatting block" do
+          record = Tempo::Views::ViewRecords::Duration.new 39000
+          formatted = record.format {|d| "I have a duration of #{d.total} seconds!"}
+          formatted.must_equal "I have a duration of 39000 seconds!"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require "test_helper"
+
+#TODO Useful tree traversal methods should become view helpers?
+def parse_tree_to_composite_record records, options={}
+  depth = options.fetch( :depth, 0 )
+  parent = options.fetch( :parent, :root )
+  view = []
+
+  records.each do |r|
+    if r.parent == parent
+      v = Tempo::Views::ViewRecords::Composite.new r, depth: depth
+      view << v
+      if not r.children.empty?
+        child_opts = options.clone
+        child_opts[:depth] = depth + 1
+        child_opts[:parent] = r.id
+        child_array = parse_tree_to_composite_record records, child_opts
+        view.push *child_array
+      end
+    end
+  end
+
+  view
+end
+
+describe Tempo do
+  describe "Views" do
+    describe "ViewRecords" do
+      describe "Composite" do
+        before do
+          tree_factory
+          @record = parse_tree_to_composite_record Tempo::Model::Tree.index
+        end
+
+        it "has a depth attribute" do
+          inspector = ""
+          @record.each {|r| inspector += "<#{r.id}:#{r.depth}>"}
+          inspector.must_equal "<1:0><3:1><7:2><8:2><2:0><4:1><5:1><6:2>"
+        end
+
+        it "has a default format" do
+          @record[7].format.must_equal "    Tree 6"
+        end
+
+        it "has a class max depth" do
+          Tempo::Views::ViewRecords::Composite.max_depth.must_equal 2
+        end
+
+        it "adds itself to the Reporter" do
+          length_before = Tempo::Views::Reporter.view_records.length
+          record = Tempo::Views::ViewRecords::Message.new "a message view record"
+          Tempo::Views::Reporter.view_records.length.must_equal length_before + 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "ViewRecords" do
+      describe "Log" do
+        before do
+          log_factory
+          @record = Tempo::Views::ViewRecords::Log.new @log_1
+        end
+
+        it "has a start_time and date id attribute" do
+          @record.d_id.must_equal "20140101"
+          @record.start_time.must_equal Time.new(2014, 1, 1, 7 )
+        end
+
+        it "has a default format" do
+          @record.format.must_equal "Messagelog 20140101-1 07:00"
+        end
+
+        it "accepts a formatting block" do
+          f = @record.format {|m| "#{m.d_id}-#{m.id}"}
+          f.must_equal "20140101-1"
+        end
+      end
+    end
+  end
+end