tempo-cli 0.1.6 → 0.2.1

data/lib/file_record/record.rb

@@ -1,65 +1,20 @@
+# Handles the CRUD of base, composite and log models
+# relies on file utility to manage the directories and filenames.
+
+require 'yaml'
+
 module FileRecord
   class Record
     class << self
 
-      # record text as a string, and all objects as yaml
-      # don't write over an existing document unless :force = true
-      # @options file file path to record to
-      # @options record string or object to record
-      # options
-      #  - force: true, overwrite file
-      #  - format: 'yaml', 'string'
-      def create( file, record, options={} )
-
-        if record.is_a?(String)
-          format = options.fetch(:format, 'string')
-        else
-          format = options.fetch(:format, 'yaml')
-        end
-
-        if File.exists?(file)
-          raise ArgumentError.new "file already exists" unless options[:force]
-        end
-
-        File.open( file,'w' ) do |f|
-
-          case format
-          when 'yaml'
-            f.puts YAML::dump( record )
-          when 'string'
-            f.puts record
-          else
-            f.puts record
-          end
-        end
-      end
-
-      def log_dirname( model )
-        dir_name = model.name[14..-1].gsub(/([A-Z])/, '_\1').downcase
-        dir = "tempo#{dir_name}s"
-      end
-
-      def log_dir( model )
-        dir_name = log_dirname model
-        dir = File.join(Dir.home,'tempo', dir_name)
-        Dir.mkdir(dir, 0700) unless File.exists?(dir)
-        dir
-      end
-
-      def log_filename( model, time )
-        file = "#{model.day_id( time )}.yaml"
-      end
+      # record a child of Tempo::Model::Base
+      def save_model( model, options={} )
 
-      def model_filename( model )
-        file_name = model.name[14..-1].gsub(/([A-Z])/, '_\1').downcase
-        file = "tempo#{file_name}s.yaml"
-      end
+        options = options.dup
+        options[:create] = true
+        options[:destroy] = true
 
-      # record a child of Tempo::Model::Base
-      def save_model( model )
-        file = model_filename model
-        file_path = File.join(Dir.home,'tempo', file)
-        File.delete( file_path ) if File.exists?( file_path )
+        file_path = FileUtility.new(model, options).file_path
 
         File.open( file_path,'a' ) do |f|
           model.index.each do |m|
@@ -69,52 +24,50 @@ module FileRecord
       end
 
       # record a child of Tempo::Model::Log
-      def save_log( model )
-        dir = log_dir model
+      def save_log( model, options={} )
+
+        options = options.dup
+        options[:create] = true
+        options[:destroy] = true
 
         model.days_index.each do |day, days_logs|
-          file = "#{day.to_s}.yaml"
-          file_path = File.join(dir, file)
-          File.delete( file_path ) if File.exists?( file_path )
 
-          # don't write to an empty file
+          options[:time] = day
+          ut = FileUtility.new(model, options)
+
+          # don't create an empty file
           next if days_logs.empty?
 
-          File.open( file_path,'a' ) do |f|
-            days_logs.each do |log|
-              f.puts YAML::dump( log.freeze_dry )
-            end
-          end
+          ut.save_instances_to_file days_logs
         end
       end
 
-      def read_instances( model, file )
+      # 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
 
-      def read_model( model )
-        file = File.join(Dir.home,'tempo', model.file)
-        read_instances model, file
-      end
+      # Read in all models instances from the model file
+      def read_model( model, options={} )
 
-      def read_log( model, time )
-        dir = File.join(Dir.home,'tempo', model.dir)
-        file = File.join(dir, model.file( time ))
-        if File.exists? file
-          read_instances model, file
-        end
+        file_path = FileUtility.new(model, options).file_path
+        read_instances model, file_path
       end
-    end
 
-    def update
+      # Read in all log model instances from a time stamped file
+      def read_log( model, time, options={} )
 
-    end
-
-    def delete
+        options[:time] = time
+        file_path = FileUtility.new(model, options).file_path
 
+        if File.exists? file_path
+          read_instances model, file_path
+        end
+      end
     end
   end
 end

data/lib/tempo/controllers/arrange_controller.rb

@@ -5,7 +5,7 @@ module Tempo
 
       class << self
 
-        def parse options, args
+        def parse(options, args)
 
           return Views.project_assistance if Model::Project.index.empty?
 
@@ -29,23 +29,23 @@ module Tempo
           end
         end
 
-        def make_root_project options, args
+        def make_root_project(options, args)
           root = match_project :arrange, options, args
           if root.parent == :root
             Views::arrange_already_root root
           else
             parent = match_project :arrange, {id: true}, root.parent
             parent.remove_child root
-            @projects.save_to_file
+            @projects.save_to_file options
             Views::arrange_root root
           end
         end
 
-        def make_child_project options, parent_args, child_args
+        def make_child_project(options, parent_args, child_args)
           parent = match_project :arrange, options, parent_args
           child = match_project :arrange, options, child_args
           parent << child
-          @projects.save_to_file
+          @projects.save_to_file options
           Views::arrange_parent_child parent, child
         end
       end #class << self

data/lib/tempo/controllers/base.rb

@@ -3,7 +3,7 @@ module Tempo
     class Base
       class << self
 
-        def filter_projects_by_title options, args
+        def filter_projects_by_title(options, args)
           if options[:exact]
             match = reassemble_the args
             match = [match]
@@ -18,7 +18,7 @@ module Tempo
         # that match positively against every
         # member of the matches array
         #
-        def fuzzy_match haystack, matches, attribute="id"
+        def fuzzy_match(haystack, matches, attribute="id")
 
           matches = [matches] unless matches.is_a? Array
 
@@ -38,7 +38,7 @@ module Tempo
         # a flag in the front. The value is also added back intto the
         # front of the original array
 
-        def reassemble_the args, flag=nil
+        def reassemble_the(args, flag=nil)
           assembled = ""
           args.unshift flag if flag
           args.each { |a| assembled += " #{a}" }
@@ -48,7 +48,7 @@ module Tempo
         private
 
         # TODO: escape regex characters ., (), etc.
-        def match_to_regex match, type=:fuzzy
+        def match_to_regex(match, type=:fuzzy)
           match.downcase!
           if type == :exact
             /^#{match}$/
@@ -57,7 +57,7 @@ module Tempo
           end
         end
 
-        def fuzzy_array_match haystack, matches
+        def fuzzy_array_match(haystack, matches)
           results = []
           matches.each do |m|
             reg = match_to_regex m
@@ -70,7 +70,7 @@ module Tempo
           haystack
         end
 
-        def model_match haystack, matches, attribute, type=:fuzzy
+        def model_match(haystack, matches, attribute, type=:fuzzy)
           attribute = "@#{attribute}".to_sym
           contenders = haystack.index
           results = []
@@ -85,7 +85,7 @@ module Tempo
           contenders
         end
 
-        def match_project command, options, args
+        def match_project(command, options, args)
           if options[:id]
             match = @projects.find_by_id args[0]
             Views::no_match_error( "projects", "id=#{args[0]}" ) if not match
@@ -99,7 +99,7 @@ module Tempo
 
         # verify one and only one match returned in match array
         # returns the single match
-        def single_match matches, request, command
+        def single_match(matches, request, command)
 
           if matches.length == 0
             Views::no_match_error "projects", request

data/lib/tempo/controllers/checkout_controller.rb

@@ -5,7 +5,7 @@ module Tempo
 
       class << self
 
-        def add_project options, args
+        def add_project(options, args)
           request = reassemble_the args, options[:add]
 
           if @projects.include? request
@@ -13,12 +13,12 @@ module Tempo
 
           else
             project = @projects.new({ title: request, current: true })
-            @projects.save_to_file
+            @projects.save_to_file options
             Views::project_checkout project
           end
         end
 
-        def existing_project options, args
+        def existing_project(options, args)
 
           match = match_project :checkout, options, args
 
@@ -27,7 +27,7 @@ module Tempo
               Views::project_already_current match
             else
               @projects.current = match
-              @projects.save_to_file
+              @projects.save_to_file options
               Views::project_checkout match
             end
           end

data/lib/tempo/controllers/end_controller.rb

@@ -8,7 +8,7 @@ module Tempo
 
       class << self
 
-        def end_timer options, args
+        def end_timer(options, args)
 
           return Views.project_assistance if Model::Project.index.empty?
 
@@ -20,17 +20,16 @@ module Tempo
 
           return Views.no_match_error( "valid timeframe", options[:at], false ) if not time_out
 
-          options = { end_time: time_out }
+          options[:end_time] = time_out
           options[:description] = reassemble_the args
 
-          @time_records.load_last_day
+          @time_records.load_last_day options
           record = @time_records.current
-
           return Views.no_items( "running time records", :error ) if ! record
 
           record.end_time = time_out
           record.description = options[:description] if options[:description]
-          @time_records.save_to_file
+          @time_records.save_to_file options
 
           Views.end_time_record_view record
 

data/lib/tempo/controllers/projects_controller.rb

@@ -5,13 +5,16 @@ module Tempo
 
       class << self
 
-        def load
-          if File.exists?( File.join( ENV['HOME'], 'tempo', @projects.file ))
-            @projects.read_from_file
+        def load(options={})
+
+          directory = options.fetch( :directory, ENV['HOME'])
+
+          if File.exists?( File.join( directory, 'tempo', @projects.file ))
+            @projects.read_from_file options
           end
         end
 
-        def index options, args
+        def index(options, args)
 
           request = reassemble_the args
 
@@ -39,7 +42,7 @@ module Tempo
           end
         end
 
-        def add options, args, tags=nil
+        def add(options, args, tags=nil)
           request = reassemble_the args
 
           if @projects.include? request
@@ -52,13 +55,13 @@ module Tempo
               @projects.current = project
             end
 
-            @projects.save_to_file
+            @projects.save_to_file options
 
             Views::project_added project
           end
         end
 
-        def delete options, args
+        def delete(options, args)
 
           reassemble_the args, options[:delete]
           match = match_project :delete, options, args
@@ -70,7 +73,7 @@ module Tempo
 
             if @projects.index.include?(match)
               match.delete
-              @projects.save_to_file
+              @projects.save_to_file options
               Views::projects_list_view if options[:list]
               Views::project_deleted match
             end
@@ -78,7 +81,7 @@ module Tempo
         end
 
         # add a project with tags, or tag or untag an existing project
-        def tag options, args
+        def tag(options, args)
 
           # TODO @projects_find_by_tag if args.empty?
 
@@ -96,7 +99,7 @@ module Tempo
             if match
               match.tag tags
               match.untag untags
-              @projects.save_to_file
+              @projects.save_to_file options
               Views::project_tags match
             end
           end

data/lib/tempo/controllers/records_controller.rb

@@ -5,17 +5,20 @@ module Tempo
 
       class << self
 
-        def initialize_from_records options, args
-          if File.exists?( File.join( ENV['HOME'], 'tempo' ))
+        def initialize_from_records(options, args)
 
-            Tempo::Controllers::Projects.load
+          dir = File.join( options.fetch( :directory, ENV['HOME']))
+
+          if File.exists?(File.join(dir, 'tempo'))
+
+            Tempo::Controllers::Projects.load directory: dir
 
           else
-            FileRecord::Directory.create_new
+            FileRecord::Directory.create_new directory: dir
           end
         end
 
       end #class << self
     end
   end
-end
+end

data/lib/tempo/controllers/report_controller.rb

@@ -6,7 +6,7 @@ module Tempo
 
       class << self
 
-        def report options, args
+        def report(options, args)
 
           return Tempo::Views.project_assistance if Tempo::Model::Project.index.empty?
 
@@ -21,7 +21,7 @@ module Tempo
             to = Time.parse options[:to]
             return Views.no_match_error( "valid timeframe", options[:to], false ) if to.nil?
 
-            @time_records.load_days_records from, to
+            @time_records.load_days_records from, to, options
 
             error_timeframe = " from #{from.strftime('%m/%d/%Y')} to #{to.strftime('%m/%d/%Y')}"
 
@@ -29,7 +29,7 @@ module Tempo
           # current day record
           #
           elsif args.empty?
-            @time_records.load_last_day
+            @time_records.load_last_day options
 
           # arguments have been supplied,
           # so we return the records for a single day
@@ -40,7 +40,7 @@ module Tempo
             day = Time.parse time
             return Views.no_match_error( "valid timeframe", time, false ) if day.nil?
 
-            @time_records.load_day_record day
+            @time_records.load_day_record day, options
 
             error_timeframe = " on #{day.strftime('%m/%d/%Y')}"
           end

data/lib/tempo/controllers/start_controller.rb

@@ -8,7 +8,7 @@ module Tempo
 
       class << self
 
-        def start_timer options, args
+        def start_timer(options, args)
 
           return Views.project_assistance if Model::Project.index.empty?
 
@@ -28,9 +28,10 @@ module Tempo
             return Views.no_match_error( "valid timeframe", options[:end], false ) if time_out.nil?
             opts[:end_time] = time_out
           end
-          @time_records.load_last_day
+
+          @time_records.load_last_day options
           record = @time_records.new(opts)
-          @time_records.save_to_file
+          @time_records.save_to_file options
 
           Views.start_time_record_view record
 

data/lib/tempo/controllers/update_controller.rb

@@ -8,20 +8,22 @@ module Tempo
 
       class << self
 
-        def parse options, args
+        def parse(options, args)
 
           reassemble_the args
 
           return Views.project_assistance if Model::Project.index.empty?
 
+          # Load last day, or specific day if options includes an on-date
           if options[:on]
             day = Time.parse options[:on]
             return Views.no_match_error( "valid timeframe", options[:from], false ) if day.nil?
-            @time_records.load_day_record day
+            @time_records.load_day_record day, options
           else
-            day = @time_records.load_last_day
+            day = @time_records.load_last_day options
           end
 
+          # Load the last record, or record by id if options includes an id
           if options[:id]
             record = @time_records.find_by_id( options[:id], day )
             return Views.no_match_error( "time record on #{day.strftime('%m/%d/%Y')}", "id = #{options[:id]}", false ) if !record
@@ -30,13 +32,22 @@ module Tempo
             return Views.no_items( "time records on #{day.strftime('%m/%d/%Y')}", :error ) if ! record
           end
 
-
+          # DELETE and existing record, no need to check for further updates
           if options[:delete]
-            record.delete
-            @time_records.save_to_file
+
+            # If only record on the given day, delete the file
+            if Tempo::Model::TimeRecord.ids(record.d_id).length == 1
+              @time_records.delete_day_record record.d_id, options
+            else
+              record.delete
+              @time_records.save_to_file options
+            end
+
             Views.delete_time_record_view record
 
-          else
+          else # check for flags and update one or all attributes
+
+            # Update the START time of the record
             if options[:start]
               start_time = Time.parse options[:start]
               return Views.no_match_error( "valid timeframe", options[:at], false ) if start_time.nil?
@@ -49,6 +60,7 @@ module Tempo
               end
             end
 
+            # Update the END time of the record
             if options[:end]
               end_time = Time.parse options[:end]
               return Views.no_match_error( "valid timeframe", options[:at], false ) if end_time.nil?
@@ -61,14 +73,16 @@ module Tempo
               end
             end
 
+            # Update the PROJECT
             if options[:project]
               record.project = @projects.current.id
             end
 
+            # Update the DESCRIPTION
             options[:description] = reassemble_the args
             record.description = options[:description] if options[:description] && !options[:description].empty?
 
-            @time_records.save_to_file
+            @time_records.save_to_file options
             Views.update_time_record_view record
           end
         end

data/lib/tempo/exceptions.rb

@@ -19,7 +19,7 @@ module Tempo
   #
   class TimeConflictError < ArgumentError
 
-    def initialize( start_time=nil, end_time=nil, target_start_time=nil, target_end_time=nil )
+    def initialize(start_time=nil, end_time=nil, target_start_time=nil, target_end_time=nil)
 
       @end_time = (end_time.kind_of? Time) ? end_time.strftime('%H:%M') : end_time.to_s
       @end_time = " - #{@end_time}" if !@end_time.empty?
@@ -36,4 +36,4 @@ module Tempo
       @message
     end
   end
-end
+end