tempo-cli 0.2.6 → 1.0.1

data/lib/tempo/controllers/records_controller.rb

@@ -7,17 +7,69 @@ module Tempo
 
         def initialize_from_records(options, args)
 
-          dir = File.join( options.fetch( :directory, ENV['HOME']))
-
-          if File.exists?(File.join(dir, 'tempo'))
+          dir = options.fetch( :directory, ENV['HOME'])
 
+          if File.exist?(File.join(dir, 'tempo'))
             Tempo::Controllers::Projects.load directory: dir
-
           else
             FileRecord::Directory.create_new directory: dir
           end
         end
 
+        def backup_records(options, args)
+          dir = options.fetch( :directory, ENV['HOME'])
+          Views::interactive_progress "\nBacking up #{dir}/tempo"
+
+          if File.exist?(File.join(dir, 'tempo'))
+            dest = FileRecord::Directory.backup directory: dir
+            Views::interactive_progress "Sucessfully created #{dest}"
+          else
+            Views::no_items("directory #{dir}/tempo", :error)
+          end
+        end
+
+        def old_records_present?(options)
+          file_utility = FileRecord::FileUtility.new(Tempo::Model::TimeRecord, options)
+          file_utility.old_style_log_records_exists?
+        end
+
+        def move_old_records(options)
+          file_utility = FileRecord::FileUtility.new(Tempo::Model::TimeRecord, options)
+          file_utility.move_old_records
+        end
+
+        def clean_records(options, args)
+          dir = File.join( options.fetch( :directory, ENV['HOME']), "tempo", "tempo_time_records")
+
+          if old_records_present? options
+
+            confirm = Tempo::Views::interactive_confirm_move_old_records
+
+            if confirm.positive_response?
+              move_old_records options
+            end
+          end
+
+          Views::interactive_progress "Loading records from #{dir}"
+
+          days = Model::TimeRecord.record_d_ids(options)
+
+          days.each do |d_id|
+            begin
+              date = "#{d_id[4..5].to_i}/#{d_id[6..7]}/#{d_id[0..3]}"
+              Views::interactive_progress_partial date
+              Model::TimeRecord.load_day_record(d_id, options)
+              Model::TimeRecord.save_to_file(options)
+              Model::TimeRecord.clear_all
+            rescue TimeConflictError => e
+              Views::message " exiting on error..."
+              Views::message "\nAn error occurred which prevented cleaning all the records on #{date}"
+              Views::message "Please repair the records in file #{dir}/#{Model::TimeRecord.file(d_id)}"
+              return Views::error e
+            end
+          end
+          Views::message "\nSuccess -- all files are clean!"
+        end
       end #class << self
     end
   end

data/lib/tempo/controllers/report_controller.rb

@@ -11,7 +11,7 @@ module Tempo
           return Tempo::Views.project_assistance if Tempo::Model::Project.index.empty?
 
           # A from flag has been supplied by the user
-          # and possible a to flag as well,
+          # and possibly a to flag,
           # so we return a period of day records
           #
           if options[:from] != "last record"

data/lib/tempo/controllers/start_controller.rb

@@ -13,14 +13,14 @@ module Tempo
           return Views.project_assistance if Model::Project.index.empty?
 
           if not options[:at]
-            start_time = Time.new()
+            start_time = Time.new().round()
           else
             start_time = Time.parse options[:at]
           end
 
           return Views.no_match_error( "valid timeframe", options[:at], false ) if start_time.nil?
 
-          if start_time > Time.new()
+          if start_time > Time.new().round()
             Views.warning("WARNING: logging time in the future may cause trouble maintaining running records")
           end
 

data/lib/tempo/exceptions.rb

@@ -70,4 +70,15 @@ module Tempo
       @message
     end
   end
+
+  class DuplicateRecordError < Exception
+
+    def initialize(file)
+      @message = "The file #{file} already exists"
+    end
+
+    def to_s
+      @message
+    end
+  end
 end

data/lib/tempo/models/log.rb

@@ -46,9 +46,13 @@ module Tempo
           FileRecord::FileUtility.new(self, {time: time}).filename
         end
 
+        def d_id_from_file(file)
+          /(\d+)\.yaml/.match(file)[1]
+        end
+
         # Returns the immediate directory for the log
         # Tempo::Model::MessageLog => tempo_message_logs
-        def dir
+        def dir(time)
           FileRecord::FileUtility.new(self).log_directory
         end
 
@@ -58,6 +62,10 @@ module Tempo
           FileRecord::FileUtility.new(self, options).log_records
         end
 
+        def record_d_ids(options={})
+          records(options).each_with_object(Array.new) {|file,d_ids| d_ids << d_id_from_file(file)}
+        end
+
         # returns the loaded record with the latest start time
         # Only loads records if options[:load] is true,
         # otherwise assumes records are already loaded
@@ -102,10 +110,9 @@ module Tempo
 
         # Return a Time object for the last record's date
         def last_day(options={})
-          reg = /(\d+)\.yaml/
           recs = records options
           if recs.last
-            d_id = reg.match(recs.last)[1]
+            d_id = d_id_from_file(recs.last)
             time = day_id_to_time d_id if d_id
             return time
           end
@@ -131,6 +138,16 @@ module Tempo
           FileRecord::FileUtility.new(self, options).file_path
         end
 
+        # Normally not necessary to perform, only
+        # used when cleaning (and testing) records
+        def clear_all
+          @ids = {}
+          @index = []
+          @days_index = {}
+          @id_counter = {}
+          @current = nil
+        end
+
         # takes and integer, and time or day_id
         # and returns the instance that matches both
         # the id and d_id

data/lib/tempo/models/time_record.rb

@@ -41,6 +41,12 @@ module Tempo
         # super handles start_time, not end time
         options[:start_time] ||= Time.now
         @end_time = options.fetch :end_time, :running
+
+        if ! options[:exact_time]
+          options[:start_time] = options[:start_time].round unless options[:start_time] == :running
+          @end_time = @end_time.round unless @end_time == :running
+        end
+
         verify_times options[:start_time], @end_time
 
         super options
@@ -146,7 +152,7 @@ module Tempo
         if @end_time.kind_of? Time
           end_time = @end_time
         else
-          end_time = Time.now()
+          end_time = Time.now().round
         end
         end_time.to_i - @start_time.to_i
       end

data/lib/tempo/version.rb

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

data/lib/tempo/views/base.rb

@@ -48,13 +48,13 @@ module Tempo
       def no_items(items, category=:info)
         ViewRecords::Message.new "no #{items} exist", category: category
         if items == "projects"
-          ViewRecords::Message.new "You must at least one project before you can begin tracking time"
+          ViewRecords::Message.new "You must create at least one project before you can begin tracking time"
           ViewRecords::Message.new "run `tempo project --help` for more information"
         end
       end
 
-      def message(message)
-        ViewRecords::Message.new message, category: :info
+      def message(message, category=:info)
+        ViewRecords::Message.new message, category: category
       end
 
       def warning(message)

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

@@ -0,0 +1,44 @@
+# The Console block handles interactive queries and progress reports.
+# It is required when reporting must be done in 'real time' rather than compiled
+# during runtime and then presented at the end (see Views::Screen). It is the only
+# formatter that receives blocks as soon as they are handed to the Reporter
+
+module Tempo
+  module Views
+    module Formatters
+
+      class Interactive < Tempo::Views::Formatters::Base
+
+
+        def message_block(record)
+          record.format do |m|
+            case m.category
+            when :immediate
+              puts "#{m.message}"
+            when :progress
+              puts "#{m.message}..."
+            when :progress_partial
+              $stdout.sync = true
+              print "#{m.message}..."
+            end
+            m.message
+          end
+        end
+
+        def query_block(query)
+          query.format do |q|
+            puts q.query
+            response = Readline.readline('> ', true)
+          end
+        end
+
+        def format_records_container(container)
+          # Pass through over-ride
+          # We don't allow interactive containers at this time because they
+          # would need to be able to detect when the container is complete.
+          # (report containers raised errors on nil durations).
+        end
+      end
+    end
+  end
+end

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

@@ -1,11 +1,10 @@
-# Tempo View Formatters are triggered by the View Reporter.
-# The View Reporter sends it's stored view messages to each
-# of it's formatters. It calls the method process records and
-# passes in the view records.  If the formatter has a class method
-# that handles the type of block passed in, it will process
-# that view record. These class methods take the name "<record type>_block"
-# where record type can be any child class of ViewRecord::Base
-# see <TODO> for an example of proc blocks.
+# Tempo View Formatters are triggered by the View Reporter, and all inherit from
+# Views::Base
+#
+# The screen formatter is the primary formatter for reporting results back to the
+# screen. All formatting is handled after the main processes, when the Reporter is
+# invoked during the post block. (If immediate feedback is needed,
+# see Formatters::Console)
 
 module Tempo
   module Views
@@ -31,7 +30,7 @@ module Tempo
           end
         end
 
-# PARTIALS --------------------------------------------------------------------/
+# PARTIALS vv-----------------------------------------------------------------vv
 
         # spacer for project titles, active project marked with *
         def active_indicator(project)
@@ -56,7 +55,7 @@ module Tempo
           @options[:id] ? "[#{id}] ".rjust(6, ' ') : ""
         end
 
-# PARTIALS --------------------------------------------------------------------/
+# PARTIALS ^^-----------------------------------------------------------------^^
 
 
         def project_block(record)

data/lib/tempo/views/interactive.rb

@@ -0,0 +1,32 @@
+module Tempo
+  module Views
+    class << self
+
+      # Must be allowed to return results
+      def interactive_query(query)
+        ViewRecords::Query.new query
+      end
+
+      def interactive_progress(message)
+        ViewRecords::Message.new message, category: :progress
+      end
+
+      def interactive_progress_partial(message)
+        ViewRecords::Message.new message, category: :progress_partial
+      end
+
+      def interactive_confirm_clean
+        query = "\nCleaning Tempo records resaves all records, looking for errors.\n" +
+                  "In the event that a record cannot be corrected, you wil be prompted to repair the record manually.\n" +
+                  "A backup of the records will also be created before any changes are made.\n\n" +
+                  "Do you wish to continue? [YyNn]"
+        interactive_query(query)
+      end
+
+      def interactive_confirm_move_old_records
+        query = "\nYou have files which match an older file structure, do you want to move them so they will be included in your records? [YyNn]"
+        interactive_query(query)
+      end
+    end
+  end
+end

data/lib/tempo/views/reporter.rb

@@ -6,6 +6,11 @@
 #
 # class instance variables:
 #
+# @@console
+#   A shell formtter which receives view records as they are created and can
+#   intercept messages that should be displayed in real time, as well as interactive
+#   prompts
+#
 # @@formats
 #   an array of formatters, which will be passed the view records on exit
 #   Reporter will always run the error formater first, to check for errors in
@@ -20,6 +25,7 @@ module Tempo
   module Views
 
     class Reporter
+      @@console
       @@formats
       @@view_records
       @@options
@@ -40,6 +46,12 @@ module Tempo
           @@options ||= {}
         end
 
+        # All records are sent directly to the console, so it can decide if
+        # action is required immediately based on the type of record
+        def console
+          @@console ||= Formatters::Interactive.new(options)
+        end
+
         def add_options(options)
           @@options ||= {}
           @@options.merge! options
@@ -50,6 +62,9 @@ module Tempo
 
           if /Views::ViewRecords/.match record.class.name
             @@view_records << record
+
+            # console must be able to return a value
+            return console.report record
           else
             raise InvalidViewRecordError
           end

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

@@ -46,6 +46,30 @@ module Tempo
         end
       end
 
+      # Query records are handled by the console formatter,
+      # returning results from a call to Readline
+      class Query
+        attr_accessor :type, :query, :match, :response
+
+        def initialize(query, options={})
+          @query = query
+          @type = "query"
+          @match = options.fetch(:match, /(y|Y)(es)?/)
+          @response = Reporter.add_view_record self
+        end
+
+        def positive_response?
+          true if @response.match(@match)
+        end
+
+        def format(&block)
+          # TODO: should we create an interactive default? using:
+          # confirm = Readline.readline('> ', true).match(/(y|Y)(es)?/)
+          block ||= lambda { |q| puts "#{q.query}"; Readline.readline('> ', true) }
+          response = block.call self
+        end
+      end
+
       # Specifically for managing a time duration, nested in other
       # view records. This can be used with a start and end time,
       # or used to manage a sum of times.

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

@@ -27,7 +27,7 @@ module Tempo
           @description = model.description
           @description ||= ""
           @duration = Duration.new model.duration
-          @end_time = model.end_time == :running ? Time.now() : model.end_time
+          @end_time = model.end_time == :running ? Time.now().round : model.end_time
           @project = model.project_title
           @running = model.running?
           self.class.max_description_length @description.length

data/tempo-cli.gemspec

@@ -12,14 +12,12 @@ spec = Gem::Specification.new do |s|
   s.description = 'tempo-cli is a command line time tracking application.  Record time spent on projects in YAML files, and manage them from the command line.'
   s.files = `git ls-files`.split("\n")
   s.require_paths << 'lib'
-  s.has_rdoc = true
   s.bindir = 'bin'
   s.executables << 'tempo'
-  s.add_development_dependency('rake', '~> 10.3')
-  s.add_development_dependency('rdoc', '~> 4.1')
-  s.add_development_dependency('aruba', '~> 0.5')
-  s.add_development_dependency('turn', '~> 0.9')
-  s.add_development_dependency('pry','~> 0.9')
-  s.add_runtime_dependency('gli', '~> 2.10')
-  s.add_runtime_dependency "chronic", "~> 0.10"
+  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'aruba', '~> 2.2'
+  s.add_development_dependency 'turn', '~> 0.9.7'
+  s.add_development_dependency 'pry','~> 0.14.2'
+  s.add_runtime_dependency 'gli', '~> 2.21', '>= 2.21.1'
+  s.add_runtime_dependency 'chronic', '~> 0.10.2'
 end

data/test/lib/file_record/directory_test.rb

@@ -2,41 +2,44 @@ require 'test_helper'
 
 describe FileRecord do
 
-  before do
+  def setup
     @dir = File.join(Dir.home,"tempo")
     @alt_dir = File.join(Dir.home, "testdir", "tempo")
-    FileUtils.rm_r @dir if File.exists?(@dir)
+    FileUtils.rm_r @dir if File.exist?(@dir)
   end
 
-  after do
-    FileUtils.rm_r @dir if File.exists?(@dir)
-    FileUtils.rm_r @alt_dir if File.exists?(@alt_dir)
+  def teardown
+    FileUtils.rm_r @dir if File.exist?(@dir)
+    FileUtils.rm_r @alt_dir if File.exist?(@alt_dir)
   end
 
-
   describe "Directory" do
 
     describe "initialize" do
 
-      it "should initialize a new directory structure" do
+      it "initializes a new directory structure" do
         project_file = File.join(@dir, "tempo_projects.yaml")
         readme = File.join(@dir, "README.txt")
 
         FileRecord::Directory.create_new
-        File.exists?( @dir ).must_equal true
-        File.exists?( project_file ).must_equal true
-        File.exists?( readme ).must_equal true
+        File.exist?( @dir ).must_equal true
+        File.exist?( project_file ).must_equal true
+        File.exist?( readme ).must_equal true
       end
 
-      it "should take an optional directory parameter" do
+      it "takes an optional directory parameter" do
         project_file = File.join(@alt_dir, "tempo_projects.yaml")
         readme = File.join(@alt_dir, "README.txt")
         dir = File.join(Dir.home, "testdir")
 
         FileRecord::Directory.create_new directory: dir
-        File.exists?( @alt_dir ).must_equal true
-        File.exists?( project_file ).must_equal true
-        File.exists?( readme ).must_equal true
+        File.exist?( @alt_dir ).must_equal true
+        File.exist?( project_file ).must_equal true
+        File.exist?( readme ).must_equal true
+      end
+
+      it "creates a zipped backup directory" do
+
       end
     end
   end

data/test/lib/file_record/record_test.rb

@@ -5,9 +5,9 @@ describe FileRecord do
   before do
     # See Rakefile for directory prep and cleanup
     dir = File.join(Dir.home,"tempo")
-    Dir.mkdir(dir, 0700) unless File.exists?(dir)
+    Dir.mkdir(dir, 0700) unless File.exist?(dir)
     @dir = File.join(Dir.home,"tempo", "tempo_unit_tests")
-    Dir.mkdir(@dir, 0700) unless File.exists?(@dir)
+    Dir.mkdir(@dir, 0700) unless File.exist?(@dir)
   end
 
   describe "Record" do
@@ -16,7 +16,7 @@ describe FileRecord do
 
       it "should create a record of all instances" do
         test_file = File.join(ENV['HOME'],'tempo','tempo_animals.yaml')
-        File.delete( test_file ) if File.exists?( test_file )
+        File.delete( test_file ) if File.exist?( test_file )
         pantherinae_factory
         FileRecord::Record.save_model( Tempo::Model::Animal )
         contents = eval_file_as_array( test_file )
@@ -28,13 +28,13 @@ describe FileRecord do
       end
     end
 
-    describe "redording a Tempo Log" do
+    describe "recording a Tempo Log" do
 
       it "should create daily records containing each instance" do
-        test_file_1 = File.join(ENV['HOME'],'tempo','tempo_message_logs', '20140101.yaml')
-        File.delete( test_file ) if File.exists?( test_file_1 )
-        test_file_2 = File.join(ENV['HOME'],'tempo','tempo_message_logs', '20140102.yaml')
-        File.delete( test_file ) if File.exists?( test_file_2 )
+        test_file_1 = File.join(ENV['HOME'],'tempo','tempo_message_logs', '2014', '20140101.yaml')
+        File.delete( test_file_1 ) if File.exist?( test_file_1 )
+        test_file_2 = File.join(ENV['HOME'],'tempo','tempo_message_logs', '2014', '20140102.yaml')
+        File.delete( test_file_2 ) if File.exist?( test_file_2 )
 
         log_factory
         FileRecord::Record.save_log(Tempo::Model::MessageLog)
@@ -67,5 +67,8 @@ describe FileRecord do
                               ":message: day 2 water the bonsai"]
       end
     end
+
+    describe "reading a Tempo Log" do
+    end
   end
 end

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

@@ -19,7 +19,7 @@ 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)
+    Dir.mkdir(@dir, 0700) unless File.exist?(@dir)
   end
 
   def after_teardown
@@ -57,7 +57,7 @@ describe Tempo do
     it "grants children the ability to write to a file" do
       frog_factory
       test_file = File.join(ENV['HOME'],'tempo','tempo_animals.yaml')
-      File.delete(test_file) if File.exists?( test_file )
+      File.delete(test_file) if File.exist?( test_file )
       contents = Tempo::Model::Animal.save_to_file
       contents = eval_file_as_array( test_file )
       contents.must_equal ["---", ":id: 1", ":genious: hyla", ":species: h. versicolor",
@@ -69,7 +69,7 @@ describe Tempo do
 
     it "grants children ability to read from a file" do
       test_file = File.join(ENV['HOME'],'tempo','tempo_animals.yaml')
-      File.delete(test_file) if File.exists?( test_file )
+      File.delete(test_file) if File.exist?( test_file )
       file_lines = [ "---", ":id: 11", ":genious: hyla", ":species: h. versicolor",
                      "---", ":id: 12", ":genious: hyla", ":species: h. chrysoscelis",
                      "---", ":id: 14", ":genious: hyla", ":species: h. andersonii",

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

@@ -5,7 +5,7 @@ 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)
+    Dir.mkdir(@dir, 0700) unless File.exist?(@dir)
   end
 
   describe "Model::Composite" do
@@ -44,7 +44,7 @@ describe Tempo do
     it "should revive a tree structure from a file" do
       tree_factory
       test_file = File.join(ENV['HOME'],'tempo','tempo_trees.yaml')
-      File.delete(test_file) if File.exists?( test_file )
+      File.delete(test_file) if File.exist?( test_file )
       contents = Tempo::Model::Tree.save_to_file
       Tempo::Model::Tree.clear_all
       Tempo::Model::Tree.read_from_file

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

@@ -5,11 +5,11 @@ 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)
+    Dir.mkdir(@dir, 0700) unless File.exist?(@dir)
   end
 
   after do
-    FileUtils.rm_r(@dir) if File.exists?(@dir)
+    FileUtils.rm_r(@dir) if File.exist?(@dir)
   end
 
   describe "Model::Log" do
@@ -34,8 +34,8 @@ describe Tempo do
     end
 
     it "knows which directory to save to" do
-      log_factory
-      Tempo::Model::MessageLog.dir.must_equal "tempo_message_logs"
+      date = Time.new(2021,1,1)
+      Tempo::Model::MessageLog.dir(date).must_equal "tempo_message_logs"
     end
 
     it "knows which file name to save to" do
@@ -44,13 +44,14 @@ describe Tempo do
       Tempo::Model::MessageLog.file(date).must_equal "20140101.yaml"
     end
 
+    #TODO-NEW-LOG-DIR
     it "grants children the ability to write to a file" do
       log_factory
       test_dir = File.join(ENV['HOME'],'tempo','tempo_message_logs')
-      FileUtils.rm_r test_dir if File.exists?(test_dir)
+      FileUtils.rm_r test_dir if File.exist?(test_dir)
       Tempo::Model::MessageLog.save_to_file
-      test_file_1 = File.join(test_dir, "20140101.yaml")
-      test_file_2 = File.join(test_dir, "20140102.yaml")
+      test_file_1 = File.join(test_dir, "2014/20140101.yaml")
+      test_file_2 = File.join(test_dir, "2014/20140102.yaml")
       contents = eval_file_as_array( test_file_1 )
       # testing with regex because time zone will be different on different computers,
       # ex: ":start_time: 2014-01-02 07:15:00.000000000 -05:00"
@@ -92,6 +93,15 @@ describe Tempo do
       Tempo::Model::MessageLog.index[0].message.must_equal "day 1 pet the sheep"
     end
 
+    it "can clear records out after load" do
+      log_record_factory
+      time = Time.new(2014, 1, 1)
+      Tempo::Model::MessageLog.load_day_record time
+      Tempo::Model::MessageLog.ids( time ).must_equal [1,2,3]
+      Tempo::Model::MessageLog.clear_all
+      Tempo::Model::MessageLog.ids( time ).must_equal []
+    end
+
     it "knows the date of the last record" do
       log_record_factory
       last_day = Tempo::Model::MessageLog.last_day

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

@@ -5,7 +5,7 @@ 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)
+    Dir.mkdir(@dir, 0700) unless File.exist?(@dir)
   end
 
   describe "Model::Project" do