tempo-cli 0.1.6 → 0.2.1

data/lib/tempo/models/base.rb

@@ -1,3 +1,12 @@
+require 'yaml'
+
+# The Base model class, from which all other models are derived.
+# Models are given a unique id, which is stored in the class index.
+# FileRecord handles all file storage and retrieval. Options are passed
+# through to FileRecord for the purpose of sending in an alternative directory.
+# example: options = {directory: "my_directory"} will save to Users/username/my_directory.
+#
+
 module Tempo
   module Model
 
@@ -29,18 +38,20 @@ module Tempo
 
         # example: Tempo::Model::Animal -> tempo_animals.yaml
         def file
-          FileRecord::Record.model_filename self
+          FileRecord::FileUtility.new(self).filename
         end
 
-        def save_to_file
-          FileRecord::Record.save_model self
+        # pass custom directory through in options
+        def save_to_file(options={})
+          FileRecord::Record.save_model self, options
         end
 
-        def read_from_file
-          FileRecord::Record.read_model self
+        # pass custom directory through in options
+        def read_from_file(options={})
+          FileRecord::Record.read_model self, options
         end
 
-        def method_missing meth, *args, &block
+        def method_missing(meth, *args, &block)
 
           if meth.to_s =~ /^find_by_(.+)$/
             run_find_by_method($1, *args, &block)
@@ -52,14 +63,14 @@ module Tempo
           end
         end
 
-        def run_sort_by_method attribute, args=@index.clone, &block
+        def run_sort_by_method(attribute, args=@index.clone, &block)
           attr = "@#{attribute}".to_sym
           args.sort! { |a,b| a.instance_variable_get( attr ) <=> b.instance_variable_get( attr ) }
           return args unless block
           block.call args
         end
 
-        def run_find_by_method attrs, *args, &block
+        def run_find_by_method(attrs, *args, &block)
           # Make an array of attribute names
           attrs = attrs.split('_and_')
 
@@ -79,14 +90,14 @@ module Tempo
         end
 
         # find by id should be exact, so we remove the array wrapper
-        def find_by_id id
+        def find_by_id(id)
           matches = find "id", id
           match = matches[0]
         end
 
         # example: Tempo::Model.find("id", 1)
         #
-        def find key, value
+        def find(key, value)
           key = "@#{key}".to_sym
           matches = []
           index.each do |i|
@@ -106,14 +117,14 @@ module Tempo
           matches
         end
 
-        def delete instance
+        def delete(instance)
           id = instance.id
           index.delete( instance )
           ids.delete( id )
         end
-      end
+      end # class methods
 
-      def initialize options={}
+      def initialize(options={})
         id_candidate = options[:id]
         if !id_candidate
           @id = self.class.next_id
@@ -133,9 +144,6 @@ module Tempo
         state.each do |attr|
           key = attr[1..-1].to_sym
           val = instance_variable_get attr
-
-          #val = val.to_s if val.kind_of? Time
-
           record[key] = val
         end
         record
@@ -147,13 +155,13 @@ module Tempo
 
       protected
 
-      def self.add_to_index member
+      def self.add_to_index(member)
         @index ||= []
         @index << member
         @index.sort! { |a,b| a.id <=> b.id }
       end
 
-      def self.add_id id
+      def self.add_id(id)
         @ids ||=[]
         @ids << id
         @ids.sort!

data/lib/tempo/models/composite.rb

@@ -1,8 +1,10 @@
+require 'yaml'
+
 # Composite Model extends base to accomodate tree structures
 # Each instance can be a root instance, or a child of another
 # instance, and each instance can have any number of children.
 # report_trees is a utility method for testing the validity of the
-# model, and cam be used as a template for creating tree reports.
+# model, and can be used as a template for creating tree reports.
 
 module Tempo
   module Model
@@ -26,7 +28,7 @@ module Tempo
           report_array += "]"
         end
 
-        def delete instance
+        def delete(instance)
           instance.children.each do |child_id|
             child = find_by_id child_id
             instance.remove_child child
@@ -47,7 +49,7 @@ module Tempo
         child.parent = self.id
       end
 
-      def remove_child( child )
+      def remove_child(child)
         @children.delete child.id
         child.parent = :root
       end

data/lib/tempo/models/log.rb

@@ -1,3 +1,9 @@
+require 'yaml'
+
+# Log extends base by allowing models to be associated with a time instance.
+# Ids are only unique by day, and each model also has a day id. Together these
+# two ids assure uniquness. When saved, each day is recorded as it's own file.
+
 module Tempo
   module Model
     class Log < Tempo::Model::Base
@@ -12,13 +18,14 @@ module Tempo
         # id counter is managed through the private methods
         # increase_id_counter and next_id below
         #
-        def id_counter time
+        def id_counter(time)
           dsym = date_symbol time
           @id_counter = {} unless @id_counter.kind_of? Hash
           @id_counter[ dsym ] ||= 1
         end
 
-        def ids time
+        # Returns an array of ids for the given day
+        def ids(time)
           dsym = date_symbol time
           @ids = {} unless @ids.kind_of? Hash
           @ids[dsym] ||= []
@@ -33,68 +40,85 @@ module Tempo
           @days_index
         end
 
-        def file time
-          FileRecord::Record.log_filename( self, time )
+        # Passthrough function, returns the log filename for a given date
+        #
+        def file(time)
+          FileRecord::FileUtility.new(self, {time: time}).filename
         end
 
+        # Returns the immediate directory for the log
+        # Tempo::Model::MessageLog => tempo_message_logs
         def dir
-          FileRecord::Record.log_dirname( self )
+          FileRecord::FileUtility.new(self).log_directory
         end
 
-        def records
-          path = FileRecord::Record.log_dir( self )
-          Dir[path + "/*.yaml"]
+        # Load all records from a directory into an array
+        # send alternate directory through options
+        def records(options={})
+          FileRecord::FileUtility.new(self, options).log_records
         end
 
-        def save_to_file
-          FileRecord::Record.save_log( self )
+        # send alternate directory through options
+        def save_to_file(options={})
+          FileRecord::Record.save_log(self, options)
         end
 
-
-        def read_from_file time
+        # send alternate directory through options
+        def read_from_file(time, options={})
           dsym = date_symbol time
           @days_index[ dsym ] = [] if not days_index.has_key? dsym
-          FileRecord::Record.read_log( self, time )
+          FileRecord::Record.read_log(self, time, options)
         end
 
         # load all the records for a single day
         #
-        def load_day_record time
+        def load_day_record(time, options={})
           dsym = date_symbol time
           if not days_index.has_key? dsym
             @days_index[ dsym ] = []
-            read_from_file time
+            read_from_file time, options
           end
         end
 
         # load the records for each day from time 1 to time 2
         #
-        def load_days_records time_1, time_2
+        def load_days_records(time_1, time_2, options={})
 
           return if time_1.nil? || time_2.nil?
 
-          days = ( time_2.to_date - time_1.to_date ).to_i
+          days = (time_2.to_date - time_1.to_date).to_i
           return if days < 0
 
-          (days + 1).times { |i| load_day_record( time_1.add_days( i ))}
+          (days + 1).times { |i| load_day_record(time_1.add_days(i), options)}
         end
 
         # load the records for the most recently recorded day
         #
-        def load_last_day
+        def load_last_day(options={})
           reg = /(\d+)\.yaml/
-          if records.last
-            d_id = reg.match(records.last)[1] if records.last
+          recs = records(options)
+          if recs.last
+            d_id = reg.match(recs.last)[1]
             time = day_id_to_time d_id if d_id
-            load_day_record time
+            load_day_record time, options
             return time
           end
         end
 
+        # delete the file for a single day
+        # this is necessary for removing a single entry on a day
+        # since updates will skip over days with no entries
+        #
+        def delete_day_record(time, options={})
+          options[:time] = time
+          options[:destroy] = true
+          FileRecord::FileUtility.new(self, options).file_path
+        end
+
         # takes and integer, and time or day_id
         # and returns the instance that matches both
         # the id and d_id
-        def find_by_id id, time
+        def find_by_id(id, time)
           time = day_id time
           ids = find "id", id
           d_ids = find "d_id", time
@@ -107,19 +131,18 @@ module Tempo
         # day_ids can be run through without change
         # Time will be converted into "YYYYmmdd"
         # ex: 1-1-2014 => "20140101"
-        def day_id time
-          if time.kind_of? String
-            return time if time =~ /^\d{8}$/
-          end
+        def day_id(time)
+          return time if time.to_s =~ /^\d{8}$/
+
           raise ArgumentError, "Invalid Time" if not time.kind_of? Time
           time.strftime("%Y%m%d")
         end
 
-        def day_id_to_time d_id
+        def day_id_to_time(d_id)
           time = Time.new(d_id[0..3].to_i, d_id[4..5].to_i, d_id[6..7].to_i)
         end
 
-        def delete instance
+        def delete(instance)
           id = instance.id
           dsym = date_symbol instance.d_id
 
@@ -129,8 +152,8 @@ module Tempo
         end
       end
 
-      def initialize( options={} )
-        @start_time = options.fetch(:start_time, Time.now )
+      def initialize(options={})
+        @start_time = options.fetch(:start_time, Time.now)
         @start_time = Time.new(@start_time) if @start_time.kind_of? String
 
         self.class.load_day_record(@start_time)
@@ -139,7 +162,7 @@ module Tempo
         id_candidate = options[:id]
         if !id_candidate
           @id = self.class.next_id @start_time
-        elsif self.class.ids( @start_time ).include? id_candidate
+        elsif self.class.ids(@start_time).include? id_candidate
           raise IdentityConflictError, "Id #{id_candidate} already exists"
         else
           @id = id_candidate
@@ -160,7 +183,7 @@ module Tempo
 
       class << self
 
-        def add_to_days_index member
+        def add_to_days_index(member)
           @days_index = {} unless @days_index.kind_of? Hash
           dsym = date_symbol member.start_time
           @days_index[dsym] ||= []
@@ -168,7 +191,7 @@ module Tempo
           @days_index[dsym].sort! { |a,b| a.start_time <=> b.start_time }
         end
 
-        def add_id time, id
+        def add_id(time, id)
           dsym = date_symbol time
           @ids = {} unless @ids.kind_of? Hash
           @ids[dsym] ||= []
@@ -176,18 +199,18 @@ module Tempo
           @ids[dsym].sort!
         end
 
-        def date_symbol time
-          day_id( time ).to_sym
+        def date_symbol(time)
+          day_id(time).to_sym
         end
 
-        def increase_id_counter time
+        def increase_id_counter(time)
           dsym = date_symbol time
           @id_counter = {} unless @id_counter.kind_of? Hash
           @id_counter[ dsym ] ||= 0
           @id_counter[ dsym ] = @id_counter[ dsym ].next
         end
 
-        def next_id time
+        def next_id(time)
           while ids(time).include? id_counter time
             increase_id_counter time
           end

data/lib/tempo/models/project.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Tempo
   module Model
     class Project < Tempo::Model::Composite
@@ -7,11 +9,11 @@ module Tempo
 
       class << self
 
-        def current( instance=nil )
+        def current(instance=nil)
           @current
         end
 
-        def current=( instance )
+        def current=(instance)
           if instance.class == self
             @current = instance
           else
@@ -19,8 +21,8 @@ module Tempo
           end
         end
 
-        def include?( title )
-          matches = find_by_title( title )
+        def include?(title)
+          matches = find_by_title(title)
           return false if matches.empty?
           matches.each do |match|
             return true if match.title == title
@@ -42,6 +44,7 @@ module Tempo
         self.class.current == self
       end
 
+      # record the active project by adding current = true
       def freeze_dry
         record = super
         if self.class.current == self
@@ -50,7 +53,7 @@ module Tempo
         record
       end
 
-      def tag( tags )
+      def tag(tags)
         return unless tags and tags.kind_of? Array
         tags.each do |tag|
           tag.split.each {|t| @tags << t if ! @tags.include? t }
@@ -58,7 +61,7 @@ module Tempo
         @tags.sort!
       end
 
-      def untag( tags )
+      def untag(tags)
         return unless tags and tags.kind_of? Array
         tags.each do |tag|
           tag.split.each {|t| @tags.delete t }

data/lib/tempo/models/time_record.rb

@@ -30,7 +30,7 @@ module Tempo
         end
       end
 
-      def initialize options={}
+      def initialize(options={})
 
         # declare these first for model organization when sent to YAML
         @project_title = nil
@@ -54,7 +54,7 @@ module Tempo
         leave_only_one_running
       end
 
-      def start_time= time
+      def start_time=time
         raise ArgumentError if !time.kind_of? Time
         if @end_time != :running
           @start_time = time if verify_times time, @end_time
@@ -66,7 +66,7 @@ module Tempo
       # end time cannot be set to :running, only to a
       # valid Time object
       #
-      def end_time= time
+      def end_time=time
         raise ArgumentError if !time.kind_of? Time
         @end_time = time if verify_times self.start_time, time
       end
@@ -74,7 +74,7 @@ module Tempo
       # method for updating both times at once, necessary if it would
       # cause a conflict to do them individually
       #
-      def update_times start_time, end_time
+      def update_times(start_time, end_time)
         raise ArgumentError if !start_time.kind_of? Time
         raise ArgumentError if !end_time.kind_of? Time
         verify_times start_time, end_time
@@ -86,7 +86,7 @@ module Tempo
       # Public method to access verify start time,
       # determine if an error will be raised
       #
-      def valid_start_time? time
+      def valid_start_time?(time)
         return false if !time.kind_of? Time
         begin
           if @end_time != :running
@@ -103,7 +103,7 @@ module Tempo
       # Public method to access verify end time,
       # determine if an error will be raised
       #
-      def valid_end_time? time
+      def valid_end_time?(time)
         return false if !time.kind_of? Time
         begin
           verify_times self.start_time, time
@@ -160,7 +160,7 @@ module Tempo
         record
       end
 
-      def tag tags
+      def tag(tags)
         return unless tags and tags.kind_of? Array
         tags.each do |tag|
           tag.split.each {|t| @tags << t if ! @tags.include? t }
@@ -168,7 +168,7 @@ module Tempo
         @tags.sort!
       end
 
-      def untag tags
+      def untag(tags)
         return unless tags and tags.kind_of? Array
         tags.each do |tag|
           tag.split.each {|t| @tags.delete t }
@@ -184,7 +184,7 @@ module Tempo
       #close current at the end time, or on the last minute
       # of the day if end time is another day
       #
-      def self.close_current end_time
+      def self.close_current(end_time)
         if end_time.day > current.start_time.day
           out = end_of_day current.start_time
           current.end_time = out
@@ -254,7 +254,7 @@ module Tempo
       # check a time against all loaded instances, verify that it doesn't
       # fall in the middle of any closed time records
       #
-      def verify_start_time time
+      def verify_start_time(time)
 
         # Check that there are currently
         # records on the day to iterate through
@@ -278,7 +278,7 @@ module Tempo
       # end time of :running. This condition, (currently only possible from init)
       # requires a second check to close out all but the most recent time entry.
       #
-      def verify_times start_time, end_time
+      def verify_times(start_time, end_time)
 
         verify_start_time start_time
 
@@ -307,7 +307,7 @@ module Tempo
       #
       # It will return true if it is exactly the record start or end time
       #
-      def time_in_record? time, record
+      def time_in_record?(time, record)
         return false if record.end_time == :running
         time >= record.start_time && time <= record.end_time
       end
@@ -318,7 +318,7 @@ module Tempo
       # this condition must be accounted for separately.
       # It assumes a valid start and end time.
       #
-      def time_span_intersects_record? start_time, end_time, record
+      def time_span_intersects_record?(start_time, end_time, record)
         if record.end_time == :running
           return true if start_time <= record.start_time && end_time > record.start_time
           return false
@@ -332,7 +332,7 @@ module Tempo
 
       # returns the last minute of the day
       #
-      def self.end_of_day time
+      def self.end_of_day(time)
         Time.new(time.year, time.month, time.day, 23, 59)
       end
     end

data/lib/tempo/version.rb

@@ -1,3 +1,3 @@
 module Tempo
-  VERSION = '0.1.6'
+  VERSION = '0.2.1'
 end

data/lib/tempo/views/arrange_view.rb

@@ -2,19 +2,19 @@ module Tempo
   module Views
     class << self
 
-      def arrange_parent_child parent, child
+      def arrange_parent_child(parent, child)
         ViewRecords::Message.new "parent project:"
         ViewRecords::Project.new parent
         ViewRecords::Message.new "child project:"
         ViewRecords::Project.new child
       end
 
-      def arrange_root project
+      def arrange_root(project)
         ViewRecords::Message.new "root project:"
         ViewRecords::Project.new project
       end
 
-      def arrange_already_root project
+      def arrange_already_root(project)
         ViewRecords::Message.new "already a root project:"
         ViewRecords::Project.new project
       end
@@ -24,4 +24,4 @@ module Tempo
       end
     end
   end
-end
+end

data/lib/tempo/views/base.rb

@@ -3,7 +3,7 @@ module Tempo
     class << self
 
       # called in the pre block, pushes relavent options to the reporter
-      def initialize_view_options command, global_options, options
+      def initialize_view_options(command, global_options, options)
         view_opts = {}
         view_opts[:verbose] = global_options[:verbose]
         view_opts[:id] = global_options[:id]
@@ -26,24 +26,7 @@ module Tempo
         Tempo::Views::Reporter.add_options view_opts
       end
 
-      # DEPRACATE- View is returned in post
-      #
-      # puts each line if output=true
-      # else returns an array of view lines
-      def return_view( view, options={} )
-        output = options.fetch( :output, true )
-
-        if output
-          if view.is_a? String
-            puts view
-          else
-            view.each { |line| puts line }
-          end
-        end
-        view
-      end
-
-      def options_report( command, global_options, options, args )
+      def options_report(command, global_options, options, args)
         globals_list = "global options: "
         global_options.each {|k,v| globals_list += "#{k} = #{v}, " if k.kind_of? String and k.length > 1 and !v.nil? }
         ViewRecords::Message.new globals_list[0..-2], category: :debug
@@ -57,20 +40,24 @@ module Tempo
         ViewRecords::Message.new "args: #{args}", category: :debug
       end
 
-      def no_items( items, category=:info )
+      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 "run `tempo project --help` for more information"
+        end
       end
 
-      def no_match_error( items, request, plural=true )
+      def no_match_error(items, request, plural=true)
         match = plural ? "match" : "matches"
         ViewRecords::Message.new "no #{items} #{match} the request: #{request}", category: :error
       end
 
-      def already_exists_error( item, request )
+      def already_exists_error(item, request)
         ViewRecords::Message.new "#{item} '#{request}' already exists", category: :error
       end
 
-      def checkout_assistance( options={} )
+      def checkout_assistance(options={})
         ViewRecords::Message.new "checkout command run with no arguments"
         ViewRecords::Message.new "perhaps you meant one of these?"
         ViewRecords::Message.new "  tempo checkout --add <new project name>"

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

@@ -17,7 +17,7 @@ module Tempo
         # record type.  See View Records for all possible record types.  See screen formatter
         # for examples of proc blocks.
         #
-        def format_records records, options={}
+        def format_records(records, options={})
           @options = options
           records.each do |record|
             class_block = "#{record.type}_block"
@@ -27,4 +27,4 @@ module Tempo
       end
     end
   end
-end
+end