tempo-cli 0.2.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59fac2395c13e4a0a58701053e5ed9696146bb44
-  data.tar.gz: 42df9a9ed12b2a50771cd0b9e64500f346bacef7
+  metadata.gz: fea9fde6712531a15750a50792f48596161e24f7
+  data.tar.gz: 9cf7aa5a815d65f23fde2da454a274334d4d04e8
 SHA512:
-  metadata.gz: 26a42ed193477f0dde232ef0209d70899d1fdc1b338e27779c5714d73f1f6b8499db8d1de0f0f81955783067f97ed2b533d336f61aafd3f11a016a18a3fa26d5
-  data.tar.gz: 77f7093821bd7a097f7cc7df90a7ea4426ff81acf10c776e3799af78a2ec6315744a82eb4e5ffedc7c556d76a32ea65c55bc64096afcfaaff8d5581e5db50d84
+  metadata.gz: e482886b1748a24e458f7c3b44ae2638f5746d25bbf8c5b4a5834fd878730f6f5f1bf2451bce3bc0e672f8908300c42a3ff92baf73d7df6fc2c8ac8721cbf1eb
+  data.tar.gz: eac361590d878b3414d557a0c672d8c5d139420e27efcf69c6022daabb268caa5cabab30daa1f6d88b2d4e440a86b96933caa2366d192824cfadd57cf370a563

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tempo-cli (0.2.5)
+    tempo-cli (1.0.0)
       chronic (~> 0.10)
       gli (~> 2.10)
 
@@ -27,7 +27,7 @@ GEM
     ffi (1.9.0)
     gherkin (2.12.0)
       multi_json (~> 1.3)
-    gli (2.11.0)
+    gli (2.12.0)
     json (1.8.1)
     method_source (0.8.1)
     multi_json (1.7.7)

data/README.md

@@ -4,7 +4,13 @@ A command line interface for time tracking by project.
 
 ## Installation
 
-    gem install tempo-cli   
+    gem install tempo-cli  
+
+## Version 1.0
+
+If you are updatging from version ~> 0.2.6 to 1.0, there is a new structure to the time records - time records are now kept in sub-folders by year.
+
+Run `tempo clean` to make a backup of your old directory, move files into the proper folders, and check all earlier records for errors.
 
 ### binary
 
@@ -18,11 +24,9 @@ Tempo cli runs with the binary `tempo`, but you can alias a shorter binary for y
 
 Tempo tracks time against projects.  Projects can be nested, and tagged, and each time entry can have an additional description.  Time reports are produced by day.  
 
-Future enhancements will include reports by project and time totals by day or by project.
-
 ### Records
 
-All records are produced in YAML files.  These reports can be edited by hand, but keep in mind that any invalid data could cause problems when it is read back into the app. Make sure time formatting is valid and that they don't overlap, and that all ids are unique per page. 
+All records are produced in YAML files.  These records can be edited by hand, but keep in mind that any invalid data could cause problems when it is read back into the app. Make sure time formatting is valid and that they don't overlap, and that all ids are unique per page. 
 
 Each day's time records are designed to work independently. When adding or updating time records, only the records for the days in question are loaded into the app. The most recent day's records will also always be read in, to assure no running records are created earlier than existing records. 
 
@@ -235,8 +239,9 @@ The description, if passed in, will be used to replace the existing description.
 
 ##### command options
  
-    --from=time - begin time records on this date
-    --to=time   - end time records on this date
+    -f, --from=time             - begin time records on this date
+    -o, --order=[project, date] - order reports by date or project
+    -t, --to=time               - end time records on this date
 
     Reports time entries for a day or a period of days. By default, lists the last recorded day's entries. To list a different day, supply a day as the args. To list a series of records, include a --from and --to value
 
@@ -254,6 +259,9 @@ The description, if passed in, will be used to replace the existing description.
     # report a period of days
     $ tempo report -f 'last monday' -t 'last friday' 
 
+    # organize reports as bullet lists under each project
+    $ tempo report --o p
+
 ## Assumptions and Limitations
 
 Before you begin using tempo, you must have at least one project. Projects can be tagged, and organized as sub-projects.  See project in the commands section below, for more information. To view your projects file, look at  ~/tempo/tempo_projects.yaml

data/bin/tempo

@@ -464,6 +464,34 @@ command [:update, :u] do |c|
   end
 end
 
+# COMMAND: CLEAN
+
+desc 'Clean the tempo file structure'
+long_desc "Creates a backup of the existing tempo directory,
+and then clean all files in the current directory.
+
+Cleaning the projects assures that:
+
+1. All projects that have been renamed have been updated in the files.
+
+2. Any files with time record conflicts are caught and can be corrected."
+
+command [:clean] do |c|
+  require 'readline'
+  c.action do |global_options, options, args|
+    controller = Tempo::Controllers::Records
+
+    confirm = Tempo::Views::interactive_confirm_clean
+
+    if confirm.positive_response?
+      controller.backup_records options, args
+      controller.clean_records options, args
+    else
+      Tempo::Views::message "Cancelling clean"
+    end
+  end
+end
+
 pre do |global,command,options,args|
 
   # add reporting of all arguments

data/features/step_definitions/tempo_steps.rb

@@ -53,9 +53,9 @@ Given /^an alternate directory and an existing project file$/ do
 end
 
 Given /^an existing time record file$/ do
-  @records_directory = File.join(ENV['HOME'], 'tempo/tempo_time_records')
+  @records_directory = File.join(ENV['HOME'], 'tempo/tempo_time_records', '2014')
   FileUtils.rm_r(@records_directory) if File.exists?(@records_directory)
-  Dir.mkdir(@records_directory, 0700)
+  FileUtils.mkdir_p @records_directory
   projects_file = File.join(@records_directory, '20140101.yaml')
 
   File.open(projects_file,'w') do |f|
@@ -107,7 +107,7 @@ end
 
 
 Then /^the time record (.*?) should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg3|
-  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1}.yaml")
+  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -118,7 +118,7 @@ Then /^the time record (.*?) should contain "(.*?)" at line (\d+)$/ do |arg1, ar
 end
 
 Then /^the time record (.*?) should not contain "(.*?)"$/ do |arg1, arg2|
-  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1}.yaml")
+  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -129,7 +129,7 @@ Then /^the time record (.*?) should not contain "(.*?)"$/ do |arg1, arg2|
 end
 
 Then /^the time record (.*?) should not exist$/ do |arg1|
-  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1}.yaml")
+  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
   File.exists?(file).should == false
 end
 
@@ -200,7 +200,7 @@ Then /^the alternate directory (.*?) file should not contain "(.*?)"$/ do |arg1,
 end
 
 Then /^the alternate directory time record (\d+) should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg3|
-  file = File.join(ENV['HOME'], 'alt_dir', 'tempo', 'tempo_time_records', "#{arg1}.yaml")
+  file = File.join(ENV['HOME'], 'alt_dir', 'tempo', 'tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -211,7 +211,7 @@ Then /^the alternate directory time record (\d+) should contain "(.*?)" at line
 end
 
 Then /^the alternate directory time record (.*?) should not exist$/ do |arg1|
-  file = File.join(ENV['HOME'], 'alt_dir', 'tempo/tempo_time_records', "#{arg1}.yaml")
+  file = File.join(ENV['HOME'], 'alt_dir', 'tempo/tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
   File.exists?(file).should == false
 end
 

data/lib/file_record/directory.rb

@@ -1,3 +1,9 @@
+require 'stringio'
+require 'rubygems/package'
+require 'rubygems/package'
+require 'zlib'
+
+
 module FileRecord
   class Directory
 
@@ -14,7 +20,7 @@ module FileRecord
 
       def create_new(options={})
 
-        directory = options.fetch( :directory, Dir.home )
+        directory = options.fetch(:directory, Dir.home)
         cwd = File.expand_path File.dirname(__FILE__)
         source = File.join(cwd, "directory_structure/tempo")
         if ! Dir.exists? directory
@@ -22,6 +28,103 @@ module FileRecord
         end
         FileUtils.cp_r source, directory
       end
+
+      # Backup the tempo directory to tempo_backup/tempo_backup_20140101_HrMnS.tar.gz
+      # pass in an optional directory (see create_new)
+      # Pass in a timestamp, or default to 20140101_120000
+      def backup(options={})
+        directory = options.fetch(:directory, Dir.home)
+        timestamp = options.fetch(:timestamp, Time.new.strftime("%Y%m%d_%H%M%S"))
+        source = File.join(directory, "tempo")
+        dest = File.join(directory, "tempo_backups")
+        Dir.mkdir dest unless Dir.exists? dest
+        destination = File.join(directory, "tempo_backups", "tempo_backup_#{timestamp}.tar.gz")
+
+        io = tar(source)
+        gz = gzip(io)
+
+        File.open(destination,"w") do |file|
+           file.binmode
+           file.write gz.read
+        end
+
+        # return the new directory name
+        destination
+      end
+
+      private
+
+      # COMPRESSION / DECOMPRESSION
+      # From: https://gist.github.com/sinisterchipmunk/1335041
+
+      # Creates a tar file in memory recursively
+      # from the given dir.
+      #
+      # Returns a StringIO whose underlying String
+      # is the contents of the tar file.
+      def tar(dir)
+        tarfile = StringIO.new("")
+        Gem::Package::TarWriter.new(tarfile) do |tar|
+          Dir[File.join(dir, "**/*")].each do |file|
+            mode = File.stat(file).mode
+            relative_file = file.sub /^#{Regexp::escape dir}\/?/, ''
+
+            if File.directory?(file)
+              tar.mkdir relative_file, mode
+            else
+              tar.add_file relative_file, mode do |tf|
+                File.open(file, "rb") { |f| tf.write f.read }
+              end
+            end
+          end
+        end
+
+        tarfile.rewind
+        tarfile
+      end
+
+      # gzips the underlying string in the given StringIO,
+      # returning a new StringIO representing the
+      # compressed file.
+      def gzip(tarfile)
+        gz = StringIO.new("")
+        z = Zlib::GzipWriter.new(gz)
+        z.write tarfile.string
+        z.close # this is necessary!
+
+        # z was closed to write the gzip footer, so
+        # now we need a new StringIO
+        StringIO.new gz.string
+      end
+
+      # un-gzips the given IO, returning the
+      # decompressed version as a StringIO
+      def ungzip(tarfile)
+        z = Zlib::GzipReader.new(tarfile)
+        unzipped = StringIO.new(z.read)
+        z.close
+        unzipped
+      end
+
+      # untars the given IO into the specified
+      # directory
+      def untar(io, destination)
+        Gem::Package::TarReader.new io do |tar|
+          tar.each do |tarfile|
+            destination_file = File.join destination, tarfile.full_name
+
+            if tarfile.directory?
+              FileUtils.mkdir_p destination_file
+            else
+              destination_directory = File.dirname(destination_file)
+              FileUtils.mkdir_p destination_directory unless File.directory?(destination_directory)
+              File.open destination_file, "wb" do |f|
+                f.print tarfile.read
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/file_record/file_utility.rb

@@ -73,14 +73,28 @@ module FileRecord
       "#{sn[0]}_#{sn[-1]}s"
     end
 
-    # Tempo::Model::Log -> Users/usrname/(alternate_directory/)tempo/tempo_logs/
+
+    def log_year_directory
+      if @time.kind_of? Time
+        @time.strftime("%Y")
+      else
+        @time[0..3]
+      end
+    end
+
+    # Tempo::Model::Log -> Users/usrname/(alternate_directory/)tempo/tempo_logs'
     # Will also create the directory if not found
-    # This method does not require time to be present in options
-    def log_directory_path
+    def log_main_directory_path
       dir = File.join(@directory, module_name, log_directory)
+    end
+
+    # Tempo::Model::Log -> Users/usrname/(alternate_directory/)tempo/tempo_logs/20XX
+    # Will also create the directory if not found
+    def log_directory_path
+      dir = File.join(log_main_directory_path, log_year_directory)
 
       if @create and !File.exists?(dir)
-        Dir.mkdir(dir, 0700)
+        FileUtils.mkdir_p dir
       end
 
       dir
@@ -104,9 +118,37 @@ module FileRecord
       clean_path File.join(dir, filename)
     end
 
+    def old_style_log_records_exists?
+      return false if !File.exists?(log_main_directory_path)
+      Pathname.new(log_main_directory_path).children.each do |c|
+        return true if c.to_s.match(/\.yaml/)
+      end
+      false
+    end
+
+    def move_old_records
+      return false if !File.exists?(log_main_directory_path)
+      puts "moving files in #{log_main_directory_path}"
+      Pathname.new(log_main_directory_path).children.each do |c|
+        if c.to_s.match(/\.yaml/)
+          year = File.basename(c).match(/(^\d{4})/)[1]
+          raise Tempo::DuplicateRecordError.new(File.join(log_main_directory_path,year,File.basename(c))) if File.exists?(File.join(log_main_directory_path,year,File.basename(c)))
+          FileUtils.mkdir_p File.join(log_main_directory_path,year) if !File.exists? File.join(log_main_directory_path,year)
+          FileUtils.cp c, File.join(log_main_directory_path,year,File.basename(c))
+          FileUtils.rm c
+        end
+      end
+    end
+
     # Returns the list of log records from a log directory
     def log_records
-      Dir[log_directory_path + "/*.yaml"].sort!
+      records = []
+      return records if !File.exists?(log_main_directory_path)
+      years = Pathname.new(log_main_directory_path).children.select { |c| c.directory? }
+      years.each do |dir|
+        records = records | Dir[dir.to_s + "/*.yaml"]
+      end
+      records.sort!
     end
 
     # remove existing file when passed destroy:true in options

data/lib/file_record/record.rb

@@ -42,15 +42,6 @@ module FileRecord
         end
       end
 
-      # Used by read_model and read_log to load all instances from a file
-      #
-      def read_instances( model, file, options={} )
-        instances = YAML::load_stream( File.open( file ) )
-        instances.each do |i|
-          model.new( i )
-        end
-      end
-
       # Read in all models instances from the model file
       def read_model( model, options={} )
 
@@ -68,6 +59,16 @@ module FileRecord
           read_instances model, file_path
         end
       end
+
+      protected
+
+      # Used by read_model and read_log to load all instances from a file
+      def read_instances( model, file, options={} )
+        instances = YAML::load_stream( File.open( file ) )
+        instances.each do |i|
+          model.new( i )
+        end
+      end
     end
   end
 end

data/lib/tempo/controllers/end_controller.rb

@@ -13,7 +13,7 @@ module Tempo
           return Views.project_assistance if Model::Project.index.empty?
 
           if not options[:at]
-            time_out = Time.new()
+            time_out = Time.new().round
           else
             time_out = Time.parse options[:at]
           end

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']))
+          dir = options.fetch( :directory, ENV['HOME'])
 
           if File.exists?(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.exists?(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.0'
 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/test/lib/file_record/directory_test.rb

@@ -2,23 +2,22 @@ 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)
   end
 
-  after do
+  def teardown
     FileUtils.rm_r @dir if File.exists?(@dir)
     FileUtils.rm_r @alt_dir if File.exists?(@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")
 
@@ -28,7 +27,7 @@ describe FileRecord do
         File.exists?( 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")
@@ -38,6 +37,10 @@ describe FileRecord do
         File.exists?( project_file ).must_equal true
         File.exists?( readme ).must_equal true
       end
+
+      it "creates a zipped backup directory" do
+
+      end
     end
   end
 end

data/test/lib/file_record/record_test.rb

@@ -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.exists?( test_file_1 )
+        test_file_2 = File.join(ENV['HOME'],'tempo','tempo_message_logs', '2014', '20140102.yaml')
+        File.delete( test_file_2 ) if File.exists?( 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/log_test.rb

@@ -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)
       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/time_record_test.rb

@@ -275,8 +275,8 @@ describe Tempo do
     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')
+      test_file_1 = File.join(ENV['HOME'],'tempo/tempo_time_records/2014/20140101.yaml')
+      test_file_2 = File.join(ENV['HOME'],'tempo/tempo_time_records/2014/20140102.yaml')
       contents = eval_file_as_array( test_file_1 )
 
       # testing with regex because time zone will be different on different computers,

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

@@ -0,0 +1,32 @@
+require "test_helper"
+
+describe Tempo do
+  describe "Views" do
+    describe "Formatters" do
+      describe "Console" do
+
+        before do
+          view_records_factory
+        end
+
+        describe "Message View Records" do
+
+          it "outputs the message" do
+            record =  @progress_message
+            formatter = Tempo::Views::Formatters::Interactive.new
+            out = capture_stdout { formatter.report record }
+
+            assert_equal "Making progress...\n", out.string
+          end
+        end
+
+        describe "Interactive View Records" do
+
+          it "outputs the interaction with a prompt" do
+            # pending
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,6 +22,12 @@ describe Tempo do
         proc { Tempo::Views::Reporter.add_view_record record }.must_raise Tempo::InvalidViewRecordError
       end
 
+      it "sends the reports immediately to the console formatter" do
+        Tempo::Views::Reporter.clear_records
+        out = capture_stdout { Tempo::Views::ViewRecords::Message.new "an immediate message to report", category: :immediate }
+        assert_equal "an immediate message to report\n", out.string
+      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"
@@ -37,4 +43,4 @@ describe Tempo do
       end
     end
   end
-end
+end

data/test/support/factories.rb

@@ -27,16 +27,6 @@ module Tempo
       end
     end
 
-    class Log
-      def self.clear_all()
-        @ids = {}
-        @index = []
-        @days_index = {}
-        @id_counter = {}
-        @current = nil
-      end
-    end
-
     class MessageLog < Tempo::Model::Log
       attr_accessor :message
 
@@ -133,10 +123,10 @@ end
 # For creating a file to load records from
 def log_record_factory
   Tempo::Model::MessageLog.clear_all
-  test_dir = File.join(ENV['HOME'],'tempo','tempo_message_logs')
+  test_dir = File.join(ENV['HOME'],'tempo','tempo_message_logs','2014')
 
   FileUtils.rm_r test_dir if File.exists?(test_dir)
-  Dir.mkdir(test_dir, 0700) unless File.exists?(test_dir)
+  FileUtils.mkdir_p(test_dir) unless File.exists?(test_dir)
   file_lines = ["---", ":start_time: 2014-01-01 07:15:00.000000000 -05:00",
                 ":id: 1", ":message: day 1 pet the sheep",
                 "---", ":start_time: 2014-01-01 07:45:00.000000000 -05:00",
@@ -170,13 +160,15 @@ end
 
 def view_records_factory
   time_record_factory
-  @message_1 = Tempo::Views::ViewRecords::Message.new "All The Things I Did", class: :title
-  @message_2 = Tempo::Views::ViewRecords::Message.new "on a busy busy day", class: :title
+  @message_1 = Tempo::Views::ViewRecords::Message.new "All The Things I Did"#, class: :title
+  @message_2 = Tempo::Views::ViewRecords::Message.new "on a busy busy day"#, class: :title
   @error = Tempo::Views::ViewRecords::Message.new "raising an error", category: :error
   @duration = Tempo::Views::ViewRecords::Duration.new 9600 # 2 hours and 40 minutes
   @project_1 = Tempo::Views::ViewRecords::Project.new @project_1
   @project_2 = Tempo::Views::ViewRecords::Project.new @project_2
   @time_record_1 = Tempo::Views::ViewRecords::TimeRecord.new @record_1
   @time_record_6 = Tempo::Views::ViewRecords::TimeRecord.new @record_6
-  #@records = [@message, @project, @time_record]
+  @progress_message = Tempo::Views::ViewRecords::Message.new "Making progress", category: :progress
+  # change to interaction:
+  @interaction = Tempo::Views::ViewRecords::Message.new "Making progress", category: :progress
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tempo-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Jonathan Gabel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -158,7 +158,9 @@ files:
 - lib/tempo/views/arrange_view.rb
 - lib/tempo/views/base.rb
 - lib/tempo/views/formatters/base.rb
+- lib/tempo/views/formatters/interactive.rb
 - lib/tempo/views/formatters/screen.rb
+- lib/tempo/views/interactive.rb
 - lib/tempo/views/projects_view.rb
 - lib/tempo/views/report_view.rb
 - lib/tempo/views/reporter.rb
@@ -183,6 +185,7 @@ files:
 - test/lib/tempo/models/time_record_test.rb
 - test/lib/tempo/views/base_test.rb
 - test/lib/tempo/views/formatters/base_test.rb
+- test/lib/tempo/views/formatters/console_test.rb
 - test/lib/tempo/views/formatters/screen_test.rb
 - test/lib/tempo/views/reporter_test.rb
 - test/lib/tempo/views/view_records/base_test.rb