tempo-cli 0.2.6 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59fac2395c13e4a0a58701053e5ed9696146bb44
-  data.tar.gz: 42df9a9ed12b2a50771cd0b9e64500f346bacef7
+SHA256:
+  metadata.gz: 4630648caa1ae6432140a0e621d276836a3a26a248ae7ab80cd8eb2a147af837
+  data.tar.gz: cb6ecc56d1cf069b75ff8a3bd54e3de81703dc20ea59b1cf85d36789bedb5254
 SHA512:
-  metadata.gz: 26a42ed193477f0dde232ef0209d70899d1fdc1b338e27779c5714d73f1f6b8499db8d1de0f0f81955783067f97ed2b533d336f61aafd3f11a016a18a3fa26d5
-  data.tar.gz: 77f7093821bd7a097f7cc7df90a7ea4426ff81acf10c776e3799af78a2ec6315744a82eb4e5ffedc7c556d76a32ea65c55bc64096afcfaaff8d5581e5db50d84
+  metadata.gz: 1c846d66d6f427e7b8610c298dbb89ae9542adcb1e61eaaaefb7f1bf0479a6be21533e14d0db1c47536339f14ee96e3f98a040418255ab6366235940d64fd883
+  data.tar.gz: 1ab3da83905ef323f6edb24d6c581e5d988d50b313d991c568a7c150ad967172f6d0625465d05c87452251dcd9703d49e38e575f27fb92d901060a2c2008f63b

data/Gemfile.lock

@@ -1,56 +1,81 @@
 PATH
   remote: .
   specs:
-    tempo-cli (0.2.5)
-      chronic (~> 0.10)
-      gli (~> 2.10)
+    tempo-cli (1.0.1)
+      chronic (~> 0.10.2)
+      gli (>= 2.21.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ansi (1.4.3)
-    aruba (0.5.3)
-      childprocess (>= 0.3.6)
-      cucumber (>= 1.1.1)
-      rspec-expectations (>= 2.7.0)
-    builder (3.2.2)
-    childprocess (0.3.9)
-      ffi (~> 1.0, >= 1.0.11)
+    ansi (1.5.0)
+    aruba (2.2.0)
+      bundler (>= 1.17, < 3.0)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 8.0, < 10.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    bigdecimal (3.1.7)
+    builder (3.2.4)
     chronic (0.10.2)
-    coderay (1.0.9)
-    cucumber (1.3.2)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12.0)
-      multi_json (~> 1.3)
-    diff-lcs (1.2.4)
-    ffi (1.9.0)
-    gherkin (2.12.0)
-      multi_json (~> 1.3)
-    gli (2.11.0)
-    json (1.8.1)
-    method_source (0.8.1)
-    multi_json (1.7.7)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
+    coderay (1.1.3)
+    contracts (0.17)
+    cucumber (9.2.0)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 11)
+      cucumber-core (> 13, < 14)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 28)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.2)
+    cucumber-ci-environment (10.0.1)
+    cucumber-core (13.0.2)
+      cucumber-gherkin (>= 27, < 28)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (> 5, < 7)
+    cucumber-cucumber-expressions (17.1.0)
+      bigdecimal
+    cucumber-gherkin (27.0.0)
+      cucumber-messages (>= 19.1.4, < 23)
+    cucumber-html-formatter (21.3.1)
+      cucumber-messages (> 19, < 25)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (6.1.0)
+    diff-lcs (1.5.1)
+    ffi (1.16.3)
+    gli (2.21.1)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (4.7.5)
+    multi_test (1.1.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (10.3.2)
-    rdoc (4.1.1)
-      json (~> 1.4)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    slop (3.4.5)
-    turn (0.9.6)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    sys-uname (1.2.3)
+      ffi (~> 1.1)
+    thor (1.3.1)
+    turn (0.9.7)
       ansi
+      minitest (~> 4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0.5)
-  pry (~> 0.9)
+  aruba (~> 2.2)
+  pry (~> 0.14.2)
   rake (~> 10.3)
-  rdoc (~> 4.1)
   tempo-cli!
-  turn (~> 0.9)
+  turn (~> 0.9.7)
+
+BUNDLED WITH
+   2.4.20

data/README.md

@@ -2,9 +2,16 @@
 
 A command line interface for time tracking by project.
 
+## A note on 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.
+
+
 ## Installation
 
-    gem install tempo-cli   
+    gem install tempo-cli  
 
 ### binary
 
@@ -18,11 +25,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 +240,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 +260,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
@@ -336,7 +345,7 @@ You can cleanup the testing directories with `bundle exec rake clean`
 
 This is a very opinionated time tracking app, you may find others that suit your working method better:
 
-If you would prefer to keep your data in a database, or run independant time sheets by project, here is a utility that uses SQLite:
+If you would prefer to keep your data in a database, or run independent time sheets by project, here is a utility that uses SQLite:
 
 [timetrap](https://github.com/samg/timetrap)
 

data/Rakefile

@@ -39,15 +39,15 @@ task :cucumber => :features
 task :tests_setup do
   @ORIGINAL_HOME = ENV['HOME']
   ENV['HOME'] = ENV['HOME'] + "/testing"
-  Dir.mkdir(ENV['HOME'], 0700) unless File.exists?(ENV['HOME'])
+  Dir.mkdir(ENV['HOME'], 0700) unless File.exist?(ENV['HOME'])
   dir = File.join(Dir.home,"tempo")
-  Dir.mkdir(dir, 0700) unless File.exists?(dir)
+  Dir.mkdir(dir, 0700) unless File.exist?(dir)
 end
 
 task :tests_teardown do
   ENV['HOME'] = @ORIGINAL_HOME
   dir = File.join(Dir.home, "testing")
-  FileUtils.rm_r dir if File.exists?(dir)
+  FileUtils.rm_r dir if File.exist?(dir)
 end
 
 require 'rake/testtask'

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

@@ -5,16 +5,16 @@ end
 
 Given /^a clean installation$/ do
   @testing_env = File.join(ENV['HOME'], 'tempo')
-  FileUtils.rm_r(@testing_env) if File.exists?(@testing_env)
+  FileUtils.rm_r(@testing_env) if File.exist?(@testing_env)
 
   # Testing global --directory argument in /alt_dir
   @alt_dir = File.join(ENV['HOME'], 'alt_dir')
-  FileUtils.rm_r(@alt_dir) if File.exists?(@alt_dir)
+  FileUtils.rm_r(@alt_dir) if File.exist?(@alt_dir)
 end
 
 Given /^an existing project file$/ do
   @testing_env = File.join(ENV['HOME'], 'tempo')
-  FileUtils.rm_r(@testing_env) if File.exists?(@testing_env)
+  FileUtils.rm_r(@testing_env) if File.exist?(@testing_env)
   Dir.mkdir(@testing_env, 0700)
   projects_file = File.join(@testing_env, 'tempo_projects.yaml')
 
@@ -34,7 +34,7 @@ end
 
 Given /^an alternate directory and an existing project file$/ do
   @testing_env = File.join(ENV['HOME'], 'alt_dir', 'tempo')
-  FileUtils.rm_r(@testing_env) if File.exists?(@testing_env)
+  FileUtils.rm_r(@testing_env) if File.exist?(@testing_env)
   FileUtils.mkdir_p(@testing_env)
   projects_file = File.join(@testing_env, 'tempo_projects.yaml')
 
@@ -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')
-  FileUtils.rm_r(@records_directory) if File.exists?(@records_directory)
-  Dir.mkdir(@records_directory, 0700)
+  @records_directory = File.join(ENV['HOME'], 'tempo/tempo_time_records', '2014')
+  FileUtils.rm_r(@records_directory) if File.exist?(@records_directory)
+  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,8 +129,8 @@ 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.exists?(file).should == false
+  file = File.join(ENV['HOME'], 'tempo/tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
+  File.exist?(file).should == false
 end
 
 Then /^the (\S*) file should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg3|
@@ -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.exists?(file).should == false
+  file = File.join(ENV['HOME'], 'alt_dir', 'tempo/tempo_time_records', "#{arg1[0..3]}", "#{arg1}.yaml")
+  File.exist?(file).should == false
 end
 

data/features/support/env.rb

@@ -16,7 +16,7 @@ Before do
   @real_home = ENV['HOME']
   @testing_env = File.join(ENV['HOME'], 'testing_features')
   #FileUtils.rm_rf @testing_env, :secure => true
-  Dir.mkdir(@testing_env, 0700) unless File.exists?(@testing_env)
+  Dir.mkdir(@testing_env, 0700) unless File.exist?(@testing_env)
   ENV['HOME'] = @testing_env
 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
 
-      if @create and !File.exists?(dir)
-        Dir.mkdir(dir, 0700)
+    # 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.exist?(dir)
+        FileUtils.mkdir_p dir
       end
 
       dir
@@ -97,22 +111,50 @@ module FileRecord
 
       dir = File.join(@directory, module_name)
 
-      if @create and !File.exists?(dir)
+      if @create and !File.exist?(dir)
         Dir.mkdir(dir, 0700)
       end
 
       clean_path File.join(dir, filename)
     end
 
+    def old_style_log_records_exists?
+      return false if !File.exist?(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.exist?(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.exist?(File.join(log_main_directory_path,year,File.basename(c)))
+          FileUtils.mkdir_p File.join(log_main_directory_path,year) if !File.exist? 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.exist?(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
     def clean_path(file_path)
 
-      if @destroy and File.exists?(file_path)
+      if @destroy and File.exist?(file_path)
         File.delete(file_path)
       end
 

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={} )
 
@@ -64,10 +55,20 @@ module FileRecord
         options[:time] = time
         file_path = FileUtility.new(model, options).file_path
 
-        if File.exists? file_path
+        if File.exist? file_path
           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/projects_controller.rb

@@ -9,7 +9,7 @@ module Tempo
 
           directory = options.fetch( :directory, ENV['HOME'])
 
-          if File.exists?( File.join( directory, 'tempo', @projects.file ))
+          if File.exist?( File.join( directory, 'tempo', @projects.file ))
             @projects.read_from_file options
           end
         end