tempo-cli 0.1.6 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce2d1ab18d47aece23c6034eb43e2c668fcb207c
+  data.tar.gz: 7a6d372bb3e12ef63730bed5cac7a30be19a73f8
+SHA512:
+  metadata.gz: 2706c79ae90158751b2059067e887d9ee65e672fcaeacf777b58a698a340dc8c1ecfeba11f730e7d1b56732c5056800c3644afaaa3ef5eeaf06d566cbfd26420
+  data.tar.gz: 3acd0dc7d1ee0d3f7a84439b2eb995d9f31ca81e325e012f493439ba2c4c0f58c489eedd61a508ff96575a478b8805aeae3a2deb83586bf44aedb348f7d782aa

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    tempo-cli (0.1.3)
+    tempo-cli (0.1.6)
       chronic (~> 0.10.2)
-      gli (= 2.6.1)
+      gli (~> 2.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -27,7 +27,7 @@ GEM
     ffi (1.9.0)
     gherkin (2.12.0)
       multi_json (~> 1.3)
-    gli (2.6.1)
+    gli (2.10.0)
     json (1.8.0)
     method_source (0.8.1)
     multi_json (1.7.7)

data/README.md

@@ -22,10 +22,16 @@ Future enhancements will include reports by project and time totals by day or by
 
 ### Records
 
-All records are produced in YAML files, at the root user directory.  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 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. 
 
 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. 
 
+#### Alternate Directory for Records
+
+By default tempo will create a directory `tempo` in the root level of the user directory, where all records are stored.  You can use the global option --directory to supply an alternate directory within the user directory. 
+
+For example, to rout to a Dropbox folder to manage syncing records across computers, you would run `tempo --directory Dropbox <your command>`. This options can also be permanently set in a configuration file. If you run `tempo --directory Dropbox initconfig` the configuration file .tempo.yaml will be created, and all tempo commands will be routed to `/Users/username/Dropbox`.
+
 ### Features
 
 #### command line assistance
@@ -315,7 +321,7 @@ run `bundle exec rake test` to run unit tests only
 
 #### run only some cucumber features
 
-add @focus before specific features and run `bundle exec rake features focus`
+add @focus before specific features and run `bundle exec rake features:focus`
 
 #### cleanup
 
@@ -333,4 +339,4 @@ If you would prefer to keep your data in a database, or run independant time she
 
 Another one worth checking out for a lightweight time tracker:
 
-[t_time_tracker](https://github.com/christiangenco/t_time_tracker)
+[t_time_tracker](https://github.com/christiangenco/t_time_tracker)

data/bin/tempo

@@ -5,9 +5,13 @@ require 'gli'
 require 'tempo'
 
 include GLI::App
+
 # to preserve all the args in ARGV:
 # preserve_argv
 
+# used to store an alternate directory path:
+config_file '.tempo.yaml'
+
 program_desc 'Command line time tracking by project
 
 For more help on any command, run: tempo [command] --help
@@ -25,6 +29,11 @@ desc 'output id'
 long_desc 'include id reporting in the command output'
 switch [:i, :id]
 
+desc 'directory'
+long_desc 'location of the tempo directory'
+default_value ENV['HOME']
+flag [:d,:directory]
+
 # desc 'Describe some flag here'
 # default_value 'the default'
 # arg_name 'The name of the argument'
@@ -200,10 +209,14 @@ long_desc "Arrange projects into a parent/child hierarchy
 
 New projects are added as root projects by default.
 
-Use the --child flag with the project command to add a new project as the child of the current project
-
 Use arrange to arrange existing projects as child or root projects.
 
+If you want to add a new project that is a child of the existing project,
+
+use the --child flag with the project command instead:
+
+$ `tempo project --child 'my new project'
+
 Arguments supplied will use fuzzy matching unless you:
 
  - Use the --exact flag to match the arguments exactly
@@ -446,6 +459,11 @@ pre do |global,command,options,args|
 
   Tempo::Views::initialize_view_options command.name, global, options
 
+  # pass a custom directory into options
+  if global[:directory] != ENV['HOME']
+    options[:directory] = File.join(ENV['HOME'], global[:directory])
+  end
+
   # Load the stored records
   Tempo::Controllers::Records.initialize_from_records options, args
 

data/features/arrange.feature

@@ -40,4 +40,4 @@ Feature: Arrange Command manages the hierarchy of a list of projects
     Then the stdout should contain "parent project:\nreading aquaculture digest"
     And the stdout should contain "child project:\naquaculture"
     And the project file should contain ":parent: 6" at line 29
-    And the project file should contain "- 4" at line 47
+    And the project file should contain "- 4" at line 47

data/features/directory.feature

@@ -0,0 +1,108 @@
+Feature: Global Directory Command allows for an alternate directory location
+  The default directory is located in the home directory
+  Adding a directory arguement will run all commands to that subdirectory within the home directory
+  Features that save to a file will save to the new sub-directory
+
+  Scenario: Adding the first project in an alternate directory creates the subdirectory and file
+    Given a clean installation
+    When I successfully run `tempo --directory alt_dir project horticulture`
+    Then the alternate directory project file should contain ":title: horticulture" at line 5
+    And the alternate directory project file should contain "current" at line 7
+
+  Scenario: Deleting a project by full match in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir project --delete "backyard bonsai"`
+    Then the stdout should contain "deleted project:\nbackyard bonsai"
+    And the alternate directory project file should not contain ":title: backyard bonsai"
+
+  Scenario: Tagging a project with a tag in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir project backyard bonsai -t patience`
+    Then the stdout should contain "backyard bonsai"
+    And the stdout should contain "tags: [miniaturization, outdoors, patience]"
+    And the alternate directory project file should contain "- patience"
+
+  Scenario: Arranging a project as a root projects in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir arrange : basement mushrooms`
+    Then the stdout should contain "root project:\nbasement mushrooms"
+    And the alternate directory project file should contain ":parent: :root" at line 20
+
+  Scenario: Arranging a project as a child of another project in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir arrange horticulture : nano aquarium`
+    Then the stdout should contain "parent project:\nhorticulture"
+    And the stdout should contain "child project:\nnano aquarium"
+    And the alternate directory project file should contain ":parent: 1" at line 39
+    And the alternate directory project file should contain "- 5" at line 7
+
+  Scenario: Checkout an existing project with checkout in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir checkout "backyard bonsai"`
+    Then the stdout should contain "switched to project:\nbackyard bonsai"
+    And the alternate directory project file should contain ":current: true" at line 18
+
+  Scenario: Adding and checking out a new project in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir checkout --add "bathtup scuba diving"`
+    Then the stdout should contain "switched to project:\nbathtup scuba diving"
+    And the alternate directory project file should contain ":title: bathtup scuba diving"
+    And the alternate directory project file should contain ":current: true"
+
+  Scenario: Starting a time record in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at "1-1-2014 7:00" filling the bathtub`
+    Then the stdout should contain "time record started"
+    And the alternate directory time record 20140101 should contain ":description: filling the bathtub" at line 3
+    And the alternate directory time record 20140101 should contain ":start_time: 2014-01-01 07:00:00" at line 4
+
+  Scenario: Ending a time record in an alternate directory
+    Given an alternate directory and an existing project file
+    When I successfully run `tempo --directory alt_dir start --at "1-1-2014 7:00" filling the bathtub`
+    And I successfully run `tempo --directory alt_dir end --at "1-1-2014 8:00"`
+    Then the stdout should contain "time record ended"
+    And the alternate directory time record 20140101 should contain ":end_time: 2014-01-01 08:00:00" at line 5
+
+  Scenario: Reporting the time entries on the current day stored in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at 7 alt directory new entry`
+    And I run `tempo --directory alt_dir end --at 8`
+    And I successfully run `tempo --directory alt_dir report`
+    Then the output should match /Records for/
+
+  Scenario: Reporting the time entries for multipe days stored in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at "2014-01-01" alt directory new entry`
+    When I run `tempo --directory alt_dir start --at "2014-01-02" alt directory newer entry`
+    And I successfully run `tempo --directory alt_dir report --from "2014-01-01" --to "2014-01-02"`
+    Then the output should contain "Records for 01/01/2014:"
+    And the output should contain "Records for 01/02/2014:"
+
+  Scenario: Reporting the time entries on a specific day stored in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at "2014-01-01" alt directory new entry`
+    And I successfully run `tempo --directory alt_dir report "2014-01-01"`
+    Then the output should contain "Records for 01/01/2014:"
+
+  Scenario: Deleting the last record stored in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at "2014-01-01" alt directory new entry`
+    And I successfully run `tempo --directory alt_dir update --delete`
+    Then the output should contain "time record deleted:"
+    And the alternate directory time record 20140101 should not exist
+
+  Scenario: Updating the last time record stored in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at "2014-01-01" alt directory new entry`
+    And I successfully run `tempo --directory alt_dir update anemone feeding`
+    Then the output should contain "time record updated:"
+    And the alternate directory time record 20140101 should contain ":description: anemone feeding" at line 3
+
+  Scenario: Updating a time record on an earlier day in an alternate directory
+    Given an alternate directory and an existing project file
+    When I run `tempo --directory alt_dir start --at "12/1/2014 7:00" --end "12/1/2014 8:00" raking leaves`
+    And I run `tempo --directory alt_dir start --at "12/2/2014 8:00" --end "12/1/2014 9:00" counting rosebuds`
+    When I successfully run `tempo --directory alt_dir update --on "12/1/2014" feeding flytraps`
+    Then the output should contain "time record updated:\n07:00 - 08:00  [1:00] horticulture: feeding flytraps"
+    And the alternate directory time record 20141201 should contain ":description: feeding flytraps" at line 3
+

data/features/project.feature

@@ -3,13 +3,13 @@ Feature: Project Command manages a list of projects
   New projects can be added and deleted
   Projects can also be tagged as inactive or inactive
 
-  Scenario: Listing projects before any projects exist
+  Scenario: Listing the current project before any projects exist
     Given a clean installation
     When I run `tempo project`
     Then the stdout should contain "no projects exist"
     And the project file should contain "#" at line 1
 
-  Scenario: Listing projects before any projects exist
+  Scenario: Listing all projects before any projects exist
     Given a clean installation
     When I run `tempo project --list`
     Then the stdout should contain "no projects exist"

data/features/report.feature

@@ -16,8 +16,9 @@ Feature: Report Command formats and outputs time records
     Given an existing project file
     When I run `tempo start -a 7 my new project`
     And I run `tempo end -a 8`
-    And I run `tempo report`
-    Then the output should match /\d{2}:\d{2} - \d{2}:\d{2}  \[\d{1,2}:\d{2}\] horticulture: my new project/
+    And I successfully run `tempo report`
+    Then the output should match /Records for/
+    And the output should match /\d{2}:\d{2} - \d{2}:\d{2}  \[\d{1,2}:\d{2}\] horticulture: my new project/
 
   Scenario: Reporting the time entries on a specific day
     Given an existing project file

data/features/start.feature

@@ -62,7 +62,6 @@ Feature: Start Command starts a new time record
     Then the stdout should contain "time record started"
     And the time record 20140101 should contain ":end_time: 2014-01-01 23:59" at line 5
 
-
   Scenario: Adding an earlier time record should immediately close out
     Given an existing project file
     When I run `tempo start --at "1-1-2014 10:00"`

data/features/step_definitions/tempo_steps.rb

@@ -4,17 +4,41 @@ When /^I get help for "([^""]*)"$/ do |app_name|
 end
 
 Given /^a clean installation$/ do
-  @testing_env = File.join( ENV['HOME'], 'tempo' )
-  FileUtils.rm_r( @testing_env ) if File.exists?( @testing_env )
+  @testing_env = File.join(ENV['HOME'], 'tempo')
+  FileUtils.rm_r(@testing_env) if File.exists?(@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)
 end
 
 Given /^an existing project file$/ do
-  @testing_env = File.join( ENV['HOME'], 'tempo' )
-  FileUtils.rm_r( @testing_env ) if File.exists?( @testing_env )
-  Dir.mkdir( @testing_env, 0700 )
-  projects_file = File.join( @testing_env, 'tempo_projects.yaml' )
+  @testing_env = File.join(ENV['HOME'], 'tempo')
+  FileUtils.rm_r(@testing_env) if File.exists?(@testing_env)
+  Dir.mkdir(@testing_env, 0700)
+  projects_file = File.join(@testing_env, 'tempo_projects.yaml')
+
+  File.open(projects_file,'w') do |f|
+    projects = ["---", ":id: 1", ":parent: :root", ":children:", "- 2", "- 3", ":title: horticulture", ":tags:", "- cultivation", ":current: true",
+                "---", ":id: 2", ":parent: 1", ":children: []", ":title: backyard bonsai", ":tags:", "- miniaturization", "- outdoors",
+                "---", ":id: 3", ":parent: 1", ":children: []", ":title: basement mushrooms", ":tags:", "- fungi", "- indoors",
+                "---", ":id: 4", ":parent: :root", ":children:", "- 5", "- 6", ":title: aquaculture", ":tags:", "- cultivation",
+                "---", ":id: 5", ":parent: 4", ":children: []", ":title: nano aquarium", ":tags:", "- miniaturization",
+                "---", ":id: 6", ":parent: 4", ":children: []", ":title: reading aquaculture digest", ":tags: []"]
+
+    projects.each do |p|
+      f.puts p
+    end
+  end
+end
 
-  File.open( projects_file,'w' ) do |f|
+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.mkdir_p(@testing_env)
+  projects_file = File.join(@testing_env, 'tempo_projects.yaml')
+
+  File.open(projects_file,'w') do |f|
     projects = ["---", ":id: 1", ":parent: :root", ":children:", "- 2", "- 3", ":title: horticulture", ":tags:", "- cultivation", ":current: true",
                 "---", ":id: 2", ":parent: 1", ":children: []", ":title: backyard bonsai", ":tags:", "- miniaturization", "- outdoors",
                 "---", ":id: 3", ":parent: 1", ":children: []", ":title: basement mushrooms", ":tags:", "- fungi", "- indoors",
@@ -29,12 +53,12 @@ Given /^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 )
-  projects_file = File.join( @records_directory, '20140101.yaml' )
+  @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)
+  projects_file = File.join(@records_directory, '20140101.yaml')
 
-  File.open( projects_file,'w' ) do |f|
+  File.open(projects_file,'w') do |f|
     records = [ ":description: putting on overalls and straw hat",
                 ":start_time: 2014-01-01 05:00:00.000000000 -05:00",
                 ":end_time: 2014-01-01 05:15:00.000000000 -05:00",
@@ -83,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}.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -94,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}.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -104,8 +128,13 @@ Then /^the time record (.*?) should not contain "(.*?)"$/ do |arg1, arg2|
   contents.should_not include arg2
 end
 
-Then /^the (.*?) file should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg3|
-  file = File.join( ENV['HOME'], 'tempo', "tempo_#{arg1}s.yaml")
+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
+end
+
+Then /^the (\S*) file should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg3|
+  file = File.join(ENV['HOME'], 'tempo', "tempo_#{arg1}s.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -115,8 +144,30 @@ Then /^the (.*?) file should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg
   contents[arg3.to_i - 1].should include arg2
 end
 
-Then /^the (.*?) file should contain "(.*?)"$/ do |arg1, arg2|
-  file = File.join( ENV['HOME'], 'tempo', "tempo_#{arg1}s.yaml")
+Then /^the (\S*) file should contain "(.*?)"$/ do |arg1, arg2|
+  file = File.join(ENV['HOME'], 'tempo', "tempo_#{arg1}s.yaml")
+  contents = []
+  File.open(file, "r") do |f|
+    f.readlines.each do |line|
+      contents << line.chomp
+    end
+  end
+  contents.should include arg2
+end
+
+Then /^the (\S*) file should not contain "(.*?)"$/ do |arg1, arg2|
+  file = File.join(ENV['HOME'], 'tempo', "tempo_#{arg1}s.yaml")
+  contents = []
+  File.open(file, "r") do |f|
+    f.readlines.each do |line|
+      contents << line.chomp
+    end
+  end
+  contents.should_not include arg2
+end
+
+Then /^the alternate directory (.*?) file should contain "(.*?)"$/ do |arg1, arg2|
+  file = File.join(ENV['HOME'], 'alt_dir',  'tempo', "tempo_#{arg1}s.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -126,8 +177,19 @@ Then /^the (.*?) file should contain "(.*?)"$/ do |arg1, arg2|
   contents.should include arg2
 end
 
-Then /^the (.*?) file should not contain "(.*?)"$/ do |arg1, arg2|
-  file = File.join( ENV['HOME'], 'tempo', "tempo_#{arg1}s.yaml")
+Then /^the alternate directory (.*?) file should contain "(.*?)" at line (\d+)$/ do |arg1, arg2, arg3|
+  file = File.join(ENV['HOME'], 'alt_dir', 'tempo', "tempo_#{arg1}s.yaml")
+  contents = []
+  File.open(file, "r") do |f|
+    f.readlines.each do |line|
+      contents << line.chomp
+    end
+  end
+  contents[arg3.to_i - 1].should include arg2
+end
+
+Then /^the alternate directory (.*?) file should not contain "(.*?)"$/ do |arg1, arg2|
+  file = File.join(ENV['HOME'], 'alt_dir', 'tempo', "tempo_#{arg1}s.yaml")
   contents = []
   File.open(file, "r") do |f|
     f.readlines.each do |line|
@@ -136,3 +198,20 @@ Then /^the (.*?) file should not contain "(.*?)"$/ do |arg1, arg2|
   end
   contents.should_not include arg2
 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")
+  contents = []
+  File.open(file, "r") do |f|
+    f.readlines.each do |line|
+      contents << line.chomp
+    end
+  end
+  contents[arg3.to_i - 1].should include arg2
+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
+end
+

data/features/update.feature

@@ -19,7 +19,13 @@ Feature: Update Command manages edits to the time records
     And an existing time record file
     When I successfully run `tempo update --delete`
     Then the stdout should contain "time record deleted:\n13:32 - 16:46  [3:14] nano aquarium: trimming the coral"
-    And the time record 20140101 should not contain "nano aquarium"
+    And the time record 20140101 should not contain ":project_title: nano aquarium"
+
+  Scenario: Deleting the only record on a day
+    Given an existing project file
+    When I run `tempo start --at "12/1/2014 7:00" --end "12/1/2014 8:00" raking leaves`
+    And I successfully run `tempo update --on "12/1/2014" --delete`
+    Then the time record 20141201 should not exist
 
   Scenario: Updating the description for the last time record
     Given an existing project file

data/lib/file_record/directory.rb

@@ -1,11 +1,27 @@
 module FileRecord
   class Directory
+
     class << self
-      def create_new
+
+
+      # Create a new directory structure, copying the contents from
+      # directory_structure/tempo into ~/tempo.
+      # If a directory is passed in through the options, the tempo directory
+      # will be created within that directory instead, in the users home folder
+      #
+      # ex. create new(directory: "custom/directory")
+      # => Users/usrname/custom/directory/tempo
+
+      def create_new(options={})
+
+        directory = options.fetch( :directory, Dir.home )
         cwd = File.expand_path File.dirname(__FILE__)
         source = File.join(cwd, "directory_structure/tempo")
-        FileUtils.cp_r( source, Dir.home )
+        if ! Dir.exists? directory
+          FileUtils.mkdir_p directory
+        end
+        FileUtils.cp_r source, directory
       end
     end
   end
-end
+end

data/lib/file_record/file_utility.rb

@@ -0,0 +1,122 @@
+# Load these file utility functions before the FileRecord::Record class
+# These functions manage the creation of storage directory and file names,
+# and check for existing directories
+
+# Base models are saved into a directory named after the parent Module
+# example Tempo::Model::Project class instances are saved into:
+# Users/usrname/tempo/tempo_projects.yaml
+# if a directory is passed into the initializer, they will be saved into an
+# alternate directory:
+# FileRecord::Utility.new directory: "custom/directory"
+# project file: Users/usrname/custom/directory/tempo/tempo_projects.yaml
+
+# Logs are saved into a subdirectory containing time stamped files
+# pass time into options on init
+# example Tempo::Model::Logs class instances are saved into:
+# Users/usrname/tempo/tempo_logs/
+# The files are given filenames based on the Logs day id (11/12/2014 -> '20141112.yaml')
+# See Tempo::Model::Logs for more information
+
+module FileRecord
+  class FileUtility
+
+    def initialize(model, options={})
+      @model = model
+      @time = options.fetch(:time, nil)
+      @directory = options.fetch(:directory, Dir.home)
+
+      # options to allow for file creation and destruction,
+      # default to false so that file path enquiries can't
+      # change the directory structure
+      @create = options.fetch( :create, false )
+      @destroy = options.fetch( :destroy, false )
+    end
+
+    def save_instances_to_file(instances)
+
+      File.open( file_path,'a' ) do |f|
+        instances.each do |i|
+          f.puts YAML::dump( i.freeze_dry )
+        end
+      end
+    end
+
+    # split Tempo::Model::Project into ["tempo", "model", "project"]
+    # split Tempo::Model::TimeRecord into ["tempo", "model", "time_record"]
+    def split_name
+      @model.name.to_s.split("::").each {|n| n.gsub!(/([a-z])([A-Z])/, '\1_\2'); n.downcase!}
+    end
+
+    # Tempo::Model::Project -> "tempo"
+    def module_name
+      split_name[0]
+    end
+
+    # Tempo::Model::Project -> "project"
+    def model_name
+      split_name[-1]
+    end
+
+    # Tempo::Model::Log on 12/1/2015 -> 20151201.yaml
+    # Tempo::Model::Base -> tempo_bases.yaml
+    def filename
+      # return Log file name
+      return "#{@model.day_id( @time )}.yaml" if @time
+
+      sn = split_name
+      file = "#{sn[0]}_#{sn[-1]}s.yaml"
+    end
+
+    # ex. Tempo::Model::Log -> tempo_logs
+    def log_directory
+      sn = split_name
+      "#{sn[0]}_#{sn[-1]}s"
+    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
+      dir = File.join(@directory, module_name, log_directory)
+
+      if @create and !File.exists?(dir)
+        Dir.mkdir(dir, 0700)
+      end
+
+      dir
+    end
+
+    # returns full path and file for model
+    # Tempo::Model::Log on 11/12/2014 -> Users/usrname/tempo/tempo_logs/20141112.yaml
+    # Tempo::Model::Base -> Users/usrname/tempo/tempo_bases.yaml
+    # Will also create directory if not found and passed create:true in options
+    # Will destroy file if passed destroy:true in options
+    def file_path
+
+      return clean_path(File.join(log_directory_path, filename)) if @time
+
+      dir = File.join(@directory, module_name)
+
+      if @create and !File.exists?(dir)
+        Dir.mkdir(dir, 0700)
+      end
+
+      clean_path File.join(dir, filename)
+    end
+
+    # Returns the list of log records from a log directory
+    def log_records
+      Dir[log_directory_path + "/*.yaml"].sort!
+    end
+
+    # remove existing file when passed destroy:true in options
+    def clean_path(file_path)
+
+      if @destroy and File.exists?(file_path)
+        File.delete(file_path)
+      end
+
+      file_path
+    end
+  end
+end