tempo-cli 0.1.0

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

@@ -0,0 +1,117 @@
+# ViewRecords are simplified models, with additional display information, used in views.
+#
+# Each viewrecord has a :type, which can be queried in the view to know
+# what type of record it is managing.
+#
+# They also each have a format method, which accept a block, and also includes a default
+# block which returns a basic formatted string.
+#
+# ViewRecords can be nested, for instance the Time ViewRecords contain
+# a Duration ViewRecord.
+#
+# View records should add themselves to the Reporter on init, with the exception of
+# partials (such as duration), which are managed within other view records
+#
+# They have no logic, and so it is up
+# to the creation method to make sure they are a correct copy of the information
+# they are representing.
+
+module Tempo
+  module Views
+
+    class InvalidViewRecordError < Exception
+    end
+
+    module ViewRecords
+
+      # The most simple view records, with a message string
+      # and a category, which defaults to :info. Categories
+      # can be used for color / logging diferentiation.
+      # category :error will raise an error after all viewRecords
+      # have been run through the reporters
+      #
+      class Message
+        attr_accessor :type, :message, :category
+
+        def initialize message, options={}
+          @message = message
+          @category = options.fetch( :category, :info )
+          @type = "message"
+          Reporter.add_view_record self
+        end
+
+        def format &block
+          block ||= lambda {|m| "#{m.message}"}
+          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.
+      #
+      # Total duration is stored in seconds.
+      #
+      # Duration records can be further queried for hours and minutes
+      # in order to construct a human redable duration.
+      # This can be used to construct time as #{hours}:#{minutes}
+      # Hours returns the total whole hours, minutes returns the remaining
+      # whole minutes after the hours have been removed from the total.
+      #
+      class Duration
+        attr_accessor :type, :total
+
+        def initialize seconds=0
+          @type = "duration"
+          @total = seconds
+        end
+
+        def format &block
+          block ||= lambda do |d|
+            "#{ d.hours.to_s }:#{ d.minutes.to_s.rjust(2, '0') }"
+          end
+          block.call self
+        end
+
+        def add seconds
+          @total += seconds
+        end
+
+        def subtract seconds
+          @total -= seconds
+        end
+
+        def hours
+          hours = ( @total / 3600 ).to_i
+        end
+
+        def minutes
+          minutes = ( @total / 60 - hours * 60 ).to_i
+        end
+      end
+
+      # Base model class, used for extending views for any child of Tempo::Model::Base
+      # Sets the id, and type, where type is the class type of the model, for example
+      # "project" for Tempo::Model::Project. ViewReord::Model should handle any type of
+      # tempo model without error, but most likely won't be as useful as a child class
+      # taylored to the specifics of the actual model's child class.
+      #
+      class Model
+        attr_accessor :id, :type
+
+        def initialize model, options={}
+          @id = model.id
+
+          # example: Tempo::Model::Something => "something"
+          @type = /Tempo::Model::(.*)$/.match( model.class.to_s )[1].downcase
+          Reporter.add_view_record self
+        end
+
+        def format &block
+          block ||= lambda {|model| "#{ model.type.capitalize} #{model.id}"}
+          block.call self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Tempo
+  module Views
+    module ViewRecords
+
+      # Base Composite model class, used for extending views for any child of Tempo::Model::Composite
+      # Inherits the id, and type from ViewRecords::Model, and adds an integer depth to hold the depth
+      # within the tree structure of the Composite model. It is important to note, the ViewRecord has
+      # no way of determining the depth of the model it represents, and this must be supplied to the
+      # instance on instantiation, or after.
+      #
+      # The Composite ViewRecord class also keeps track of the max depth of all of it's members, this
+      # can be used to calculate the padding added to any views.
+      #
+      # The Composite View Model is an abstract model that is extended to create views for children
+      # of the Composite Model class. See ViewRecords::Project for an example.
+      #
+      class Composite < ViewRecords::Model
+        attr_accessor :depth
+
+        class << self
+          def max_depth depth=0
+            @max_depth ||= 0
+            @max_depth = @max_depth > depth ? @max_depth : depth
+          end
+        end
+
+        def initialize model, options={}
+          super model, options
+          @depth = options.fetch(:depth, 0)
+          self.class.max_depth @depth
+        end
+
+        def format &block
+          block ||= lambda {|model| "#{"  " * model.depth}#{ model.type.capitalize} #{model.id}"}
+          block.call self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Tempo
+  module Views
+    module ViewRecords
+
+      # Base Composite log class, used for extending views for any child of Tempo::Model::Log
+      # Inherits the id, and type from ViewRecords::Model, and adds an start time and date_id.
+      #
+      #
+      # The Log View Model is an abstract model that is extended to create views for children
+      # of the Log Model class. See ViewRecords::TimeRecord for an example.
+      #
+      class Log < ViewRecords::Model
+        attr_accessor :start_time, :d_id
+
+        def initialize model, options={}
+          super model, options
+          @start_time = model.start_time
+          @d_id = model.d_id
+        end
+
+        def format &block
+          block ||= lambda {|model| "#{ model.type.capitalize} #{model.d_id}-#{model.id} #{model.start_time.strftime('%H:%M')}"}
+          block.call self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Tempo
+  module Views
+    module ViewRecords
+
+      # Project ViewRecords adds the project title, any tags, and a
+      # duration to the composite model.  It also keeps track of the
+      # maximum title length of all Project views.
+      #
+      # :depth is inhereted from Composite
+      #
+      class Project < ViewRecords::Composite
+        attr_accessor :title, :tags, :current, :duration
+
+        class << self
+          def max_title_length len=0
+            @max_title_length ||= 0
+            @max_title_length = @max_title_length > len ? @max_title_length : len
+          end
+        end
+
+        def initialize model, options={}
+          super model, options
+          @title = model.title
+          @tags = model.tags
+          @current = model.current?
+          @duration = Duration.new
+          self.class.max_title_length @title.length
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Tempo
+  module Views
+    module ViewRecords
+
+      # TimeRecord adds a description, project and end_time and running flag
+      # to the Log Record to represent any instance of the TimeRecord model.
+      # It also includes a Duration ViewRecord for presenting the total duration
+      # of the time record.
+      #
+      class TimeRecord < ViewRecords::Log
+        attr_accessor :description, :duration, :end_time, :project, :running
+
+        class << self
+          def max_description_length len=0
+            @max_description_length ||= 0
+            @max_description_length = @max_description_length > len ? @max_description_length : len
+          end
+
+          def max_project_length len=0
+            @max_project_length ||= 0
+            @max_project_length = @max_project_length > len ? @max_project_length : len
+          end
+        end
+
+        def initialize model, options={}
+          super model, options
+          @description = model.description
+          @description ||= ""
+          @duration = Duration.new model.duration
+          @end_time = model.end_time == :running ? Time.now() : model.end_time
+          @project = model.project_title
+          @running = model.running?
+          self.class.max_description_length @description.length
+          self.class.max_project_length @project.length
+        end
+
+        def format &block
+          block ||= lambda do |m|
+            running = m.running ? "*" : " "
+            description = @description ? "#{m.project}: #{m.description}" : "#{m.project}"
+            "#{m.start_time.strftime('%H:%M')} - #{m.end_time.strftime('%H:%M')}#{running} [#{m.duration.format}] #{description}"
+          end
+          block.call self
+        end
+      end
+    end
+  end
+end

data/lib/tempo.rb

@@ -0,0 +1,26 @@
+# All files required for Tempo to run:
+
+# Additional functionality to the time class, requires Chronic:
+require 'time_utilities.rb'
+
+require 'tempo/version.rb'
+
+require 'tempo/models/base.rb'
+require 'tempo/models/composite.rb'
+require 'tempo/models/log.rb'
+Dir[File.dirname(__FILE__) + '/tempo/models/*.rb'].each {|file| require file }
+
+require 'tempo/controllers/base.rb'
+Dir[File.dirname(__FILE__) + '/tempo/controllers/*.rb'].each {|file| require file }
+
+Dir[File.dirname(__FILE__) + '/tempo/views/view_records/*.rb'].each {|file| require file }
+
+require 'tempo/views/reporter.rb'
+require 'tempo/views/formatters/base.rb'
+Dir[File.dirname(__FILE__) + '/tempo/views/formatters/*.rb'].each {|file| require file }
+
+require 'tempo/views/base.rb'
+Dir[File.dirname(__FILE__) + '/tempo/views/*.rb'].each {|file| require file }
+
+require 'file_record/directory.rb'
+require 'file_record/record.rb'

data/lib/time_utilities.rb

@@ -0,0 +1,30 @@
+require 'chronic'
+# see also
+# http://rtmatheson.com/2011/12/rounding-time-to-the-closest-hour-in-ruby/
+
+class Time
+
+  class << self
+    def parse time
+      # Chronic will usually return nil when unable to parse time
+      # it throws an error, on 't' and a few other string, so we
+      # capture these here an assure that nil is returned
+      begin
+        chron = Chronic.parse time
+        chron.round
+      rescue Exception => e
+        return nil
+      end
+    end
+  end
+
+  #default to whole minutes
+  def round options={}
+    seconds = 60
+    Time.at((self.to_f / seconds).round * seconds)
+  end
+
+  def add_days days
+    t = self + days * 86400 # 24 * 60 * 60
+  end
+end

data/tempo-cli.gemspec

@@ -0,0 +1,26 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','tempo','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'tempo-cli'
+  s.version = Tempo::VERSION
+  s.author = 'Jonathan Gabel'
+  s.email = 'hello@jonathangabel.com'
+  s.homepage = 'http://jonathangabel.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A command line time tracker for recording by day or by project'
+  s.description = 'Record and report time spent by project'
+# Add your other files here if you make them
+# Add lib files to lib.tempo.rb
+  s.files = `git ls-files`.split("\n")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.bindir = 'bin'
+  s.executables << 'tempo'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_development_dependency('turn', '~> 0.9.6')
+  s.add_development_dependency('pry','~> 0.9.12.2')
+  s.add_runtime_dependency('gli','2.6.1')
+  s.add_runtime_dependency "chronic", "~> 0.10.2"
+end

data/test/lib/file_record/directory_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+describe FileRecord do
+
+  before do
+    @dir = File.join(Dir.home,"tempo")
+    FileUtils.rm_r @dir if File.exists?(@dir)
+  end
+
+  after do
+    FileUtils.rm_r @dir if File.exists?(@dir)
+  end
+
+
+  describe "Directory" do
+
+    describe "initialize" do
+
+      it "should initialize a new directory structure" do
+        project_file = File.join(@dir, "tempo_projects.yaml")
+        readme = File.join(@dir, "README.txt")
+
+        FileRecord::Directory.create_new
+        File.exists?( @dir ).must_equal true
+        File.exists?( project_file ).must_equal true
+        File.exists?( readme ).must_equal true
+      end
+    end
+  end
+end

data/test/lib/file_record/record_test.rb

@@ -0,0 +1,106 @@
+require 'test_helper'
+
+describe FileRecord do
+
+  before do
+    # See Rakefile for directory prep and cleanup
+    dir = File.join(Dir.home,"tempo")
+    Dir.mkdir(dir, 0700) unless File.exists?(dir)
+    @dir = File.join(Dir.home,"tempo", "tempo_unit_tests")
+    Dir.mkdir(@dir, 0700) unless File.exists?(@dir)
+  end
+
+  describe "Record" do
+
+      before do
+        @file = File.join( @dir, "filerecord_create.txt")
+      end
+
+      after do
+        File.delete(@file) if File.exists?(@file)
+      end
+
+    describe "create" do
+
+      it "should create a new record" do
+        FileRecord::Record.create( @file, "" )
+        File.exists?( @file ).must_equal true
+      end
+
+      it "should raise and error if the file exists" do
+        FileRecord::Record.create( @file, "" )
+        proc { FileRecord::Record.create( @file, "" ) }.must_raise ArgumentError
+      end
+
+      it "should overwrite a file with option :force" do
+        File.open( @file,'w' ) do |f|
+          f.puts "Now this file already exists"
+        end
+        FileRecord::Record.create( @file, "overwrite file", force: true )
+        contents  = eval_file_as_array( @file )
+        contents.must_equal ["overwrite file"]
+      end
+    end
+
+    describe "recording a string" do
+      it "should be able to record a string" do
+        FileRecord::Record.create( @file, "a simple string" )
+        contents = eval_file_as_array( @file )
+        contents.must_equal ["a simple string"]
+      end
+
+      it "should be able to record a string as yaml" do
+        FileRecord::Record.create( @file, "a simple string", format: 'yaml' )
+        contents = eval_file_as_array( @file )
+        contents.must_equal ["--- a simple string", "..."]
+      end
+    end
+
+      describe "recording and array" do
+
+      it "should be able to record a shallow array as string" do
+        FileRecord::Record.create( @file, ["a","simple","array"], format: "string" )
+        contents = eval_file_as_array( @file )
+        contents.must_equal ["a","simple","array"]
+      end
+
+      it "should default to recording a shallow array as yaml" do
+        FileRecord::Record.create( @file, ["a","simple","array"] )
+        contents = eval_file_as_array( @file )
+        contents.must_equal ["---", "- a", "- simple", "- array"]
+      end
+
+      it "should record a nested array as yaml" do
+        FileRecord::Record.create( @file, ["a",["nested",["array"]]])
+        contents = eval_file_as_array( @file )
+        contents.must_equal ["---", "- a", "- - nested", "  - - array"]
+      end
+    end
+
+    describe "recording a hash" do
+
+      it "should default to and record a hash as yaml" do
+        hash = {a: 1, b: true, c: Hash.new, d: "object", with: ['an', 'array']}
+        FileRecord::Record.create( @file, hash )
+        contents = eval_file_as_array( @file )
+        contents.must_equal ["---", ":a: 1", ":b: true", ":c: {}", ":d: object", ":with:", "- an", "- array"]
+      end
+    end
+
+    describe "recording a Tempo Model" do
+
+      it "should create a record of all instances" do
+        test_file = File.join(ENV['HOME'],'tempo','tempo_animals.yaml')
+        File.delete( test_file ) if File.exists?( test_file )
+        pantherinae_factory
+        FileRecord::Record.save_model( Tempo::Model::Animal )
+        contents = eval_file_as_array( test_file )
+        contents.must_equal [ "---", ":id: 1", ":genious: Panthera", ":species: p. tigris",
+                              "---", ":id: 2", ":genious: Panthera", ":species: p. leo",
+                              "---", ":id: 3", ":genious: Panthera", ":species: p. onca",
+                              "---", ":id: 4", ":genious: Panthera", ":species: p. pardus",
+                              "---", ":id: 5", ":genious: Panthera", ":species: p. zdanskyi"]
+      end
+    end
+  end
+end

data/test/lib/tempo/controllers/base_controller_test.rb

@@ -0,0 +1,60 @@
+require "test_helper"
+
+describe Tempo::Controllers::Base do
+  describe "Class Methods" do
+
+    before do
+      @controller = Tempo::Controllers::Base
+    end
+
+    describe "fuzzy match" do
+      describe "matching an array" do
+
+        before do
+          @haystack = ['sheep','ducks','peeping-ducks','sheep ducks']
+        end
+
+        it "should find all matches to a single match object" do
+          @controller.fuzzy_match( @haystack, 'ducks' ).must_equal ['ducks','peeping-ducks','sheep ducks']
+        end
+
+        it "should find all matches to an array of match objects" do
+          @controller.fuzzy_match( @haystack, ['ducks', 'eep'] ).must_equal ['peeping-ducks','sheep ducks']
+        end
+      end
+
+      describe "matching a Tempo Model" do
+
+        before do
+          pantherinae_factory
+        end
+
+        it "should find all matches to a single match object" do
+          matches = @controller.fuzzy_match( Tempo::Model::Animal, "Panthera", "genious" )
+          matches.length.must_equal 5
+        end
+
+        it "should find all matches to an array of match objects" do
+          matches = @controller.fuzzy_match( Tempo::Model::Animal, ["p. ", "a"], "species" )
+          # "p. onca", "p. pardus" "p. zdanskyi"
+          matches.length.must_equal 3
+        end
+      end
+    end
+
+    describe "reassemble to args" do
+
+      it "should reassemble the args passed in as an array" do
+        test_args = ["an", "array", "of", "args"]
+        test_flag = "I'm"
+        @controller.reassemble_the( test_args ).must_equal "an array of args"
+      end
+
+      it "should reassemble the args with a flag in the front" do
+        test_args = ["an", "array", "of", "args"]
+        test_flag = "I'm"
+        @controller.reassemble_the( test_args, test_flag ).must_equal "I'm an array of args"
+      end
+    end
+  end
+end

data/test/lib/tempo/controllers/project_controller_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+describe Tempo::Controllers::Projects do
+  describe "Class Methods" do
+
+    before do
+      @controller = Tempo::Controllers::Projects
+    end
+
+    describe "exact match" do
+
+      before do
+        project_factory
+        Tempo::Model::Project.new title: 'horticulture'
+      end
+
+      it "should find an exact match" do
+        match1 = @controller.filter_projects_by_title({ exact: true }, ["horticulture"])
+        match1.length.must_equal 1
+        match1[0].title.must_equal "horticulture"
+      end
+    end
+  end
+end