piece_of_wax 1.0.0.rc1 → 1.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818b72b11bd06930c11e17c07e72512f9a4b1864dfb00090c681226414b720a3
-  data.tar.gz: f2423eb394952af0fadd964245b4637e5e2b58267933442459ea89dbe3203640
+  metadata.gz: 7e3d7bf2ae9792450cc94d927669b1d48e8c4abdde8285c7580532065372780c
+  data.tar.gz: a2728bf010e7a3be407291ed6bd037a1c45fee19f2813e2f3d103ceae87f6649
 SHA512:
-  metadata.gz: 105bd336b6d5d5ed58b53263fe05ed542f3b1dc35c2d346239f469d2935a9e73b2ad05249db8e984d28843b077b3a1850f5ab456825a43813b3673c48294bb51
-  data.tar.gz: 20b656e3e4fb4bb5a53e69ee010a0bcf87845479e437c267a549855cfca70be9a12393d5787c2d507fc66526d499e47599e36a5fc44f0d9e8fa7bb05446ad709
+  metadata.gz: 0165421b35cf5701533a15aba5d62f324ad575686588b6858336fcc9e21171b98103019191ba67bf6c512ffa8fc39604a3bbac496f3d810ae455772faeca82a6
+  data.tar.gz: 64cf7f4ddb03e81c714892e0381bbc948883185bbf0124e36a7fcdfec8ee34b90a3f0168aa2bddf69a5dea35b0b9614cceb442bc6ea34a280bdba4d7e92a6e7b

data/bin/piece_of_wax

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'piece_of_wax'
+require "piece_of_wax"
 PieceOfWax::CLI.start(ARGV)

data/lib/piece_of_wax.rb

@@ -1,38 +1,111 @@
+# frozen_string_literal: true
+
 require "json"
 require "piece_of_wax/cli_options"
-require "piece_of_wax/date_time"
+require "piece_of_wax/date_time_helper"
 require "piece_of_wax/date_time_decorator/error_message_display"
 require "piece_of_wax/logfile"
 require "thor"
 
 module PieceOfWax
+  #
+  # Implements command line interface. Each public method corresponds to a `piece_of_wax`
+  # subcommand.
+  #
   class CLI < Thor
-    desc 'activity "_activity_"', "log activity (wrap multi-word entries in quotation marks)"
-    option :time, aliases: :t, desc: 'time when activity was started'
-    def activity(str)
-      CLIOptions.instance.set(options)
-      time = DateTime.safe_parse(options[:time]) || DateTime.current_time
-      Logfile.new(DateTime.current_date).add_activity(time, str)
-      $stdout.puts "wrote #{str} to file"
+    desc 'activity "_activity_"', "log activity"
+    option :time, aliases: :t, desc: "time when activity was started"
+    def activity(*str)
+      capture_options(options)
+      time = DateTimeHelper.safe_parse(CLIOptions.instance[:time]) || DateTimeHelper.current_time
+      description = str.join(" ")
+      Logfile.new(DateTimeHelper.current_date).add_activity(time, description)
+      $stdout.puts "wrote #{description} to file"
     end
 
-    desc "read [date]", "print activities on given [date] (yesterday by default)"
-    option :military, aliases: :m, desc: 'render time in military (24-hour) format'
-    def read(date_str = '')
-      CLIOptions.instance.set(options)
-      date = DateTime.safe_parse(date_str) || DateTime.current_date
-      logfile = Logfile.new(date)
-      if logfile.contents
+    desc 'edit "_activity_"', "edit activity"
+    option :n, default: "1", desc: "the activity to edit, 1 being the most recently-logged"
+    def edit(*str)
+      capture_options(options)
+      description = str.join(" ")
+      index = (0 - CLIOptions.instance[:n].to_i)
+      logfile = Logfile.new(DateTimeHelper.current_date)
+      if logfile.contents[index]
+        logfile.edit_activity(index, description)
+        $stdout.puts "wrote #{description} to file"
+      else
+        warn 'activity referenced by "n" option does not exist'
+      end
+    end
+
+    desc "read [date]", "print activities on given [date] (today by default)"
+    option :military, aliases: :m, desc: "render time in military (24-hour) format"
+    option(
+      :'quitting-time',
+      default: "17:45:00 -0500",
+      aliases: :q,
+      desc: "last activity period is capped off at this time"
+    )
+    def read(date_str = "")
+      capture_options(options)
+      date = get_date(date_str)
+      logfile = Logfile.new(date) if date
+      if logfile&.any_contents?
         $stdout.puts logfile
       else
-        $stderr.puts "Sorry, I couldn't find any logs for #{DateTimeDecorator::ErrorMessageDisplay.new(date)}."
+        error_message(date_str, date)
       end
     end
 
     private
 
+    def capture_options(options)
+      CLIOptions.instance.set(options)
+    end
+
+    def get_date(date_str)
+      if date_str == "previous"
+        previous_logfile_date
+      else
+        DateTimeHelper.safe_parse(date_str) || DateTimeHelper.current_date
+      end
+    end
+
+    def error_message(date_str, date)
+      if date_str == "previous" && date.nil?
+        warn(
+          "Sorry, I couldn't find any logs prior to "\
+          "#{DateTimeDecorator::ErrorMessageDisplay.new(DateTimeHelper.current_date)}."
+        )
+      else
+        warn "Sorry, I couldn't find any logs for #{DateTimeDecorator::ErrorMessageDisplay.new(date)}."
+      end
+    end
+
     def exit_on_failure?
       true
     end
+
+    #
+    # @return [Logfile] most recent logfile (excluding current date)
+    #
+    # rubocop:disable Metrics/MethodLength
+    def previous_logfile_date
+      # rubocop:enable Metrics/MethodLength
+      logfile_dates =
+        Dir.entries(".").map do |filename|
+          date = filename.gsub(".txt", "")
+          DateTimeHelper.safe_parse(date)
+        end.compact
+      most_recent_date, second_most_recent_date =
+        logfile_dates.sort.reverse.first(2)
+      # if most recent logfile is from today, return the
+      # second most recent
+      if most_recent_date&.to_date == Date.today
+        second_most_recent_date
+      else
+        most_recent_date
+      end
+    end
   end
 end

data/lib/piece_of_wax/cli_options.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "singleton"
+
+module PieceOfWax
+  #
+  # Singleton class that stores options/flags passed from the command line. Purpose
+  # of the class is to make these options globally available.
+  #
+  class CLIOptions
+    include Singleton
+    extend Forwardable
+
+    def [](key)
+      options[key]
+    end
+
+    def set(opts)
+      raise "CLIOptions is an immutable singleton; #set can only be called once per program execution" if options.any?
+
+      @options = opts
+    end
+
+    private
+
+    def options
+      @options || {}
+    end
+  end
+end

data/lib/piece_of_wax/date_time_decorator/error_message_display.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "piece_of_wax/date_time"
+
+module PieceOfWax
+  module DateTimeDecorator
+    #
+    # Decorator class designed to wrap DateTime instances. Implements form of to_s used
+    # to render error messages.
+    #
+    class ErrorMessageDisplay
+      def initialize(date_time)
+        @date_time = date_time
+      end
+
+      def to_s
+        case @date_time.to_date
+        when DateTimeHelper.current_date
+          "today"
+        when DateTimeHelper.current_date.prev_day
+          "yesterday"
+        else
+          @date_time.strftime("%Y-%-m-%-d")
+        end
+      end
+    end
+  end
+end

data/lib/piece_of_wax/date_time_decorator/read_display.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PieceOfWax
+  module DateTimeDecorator
+    #
+    # Decorator class designed to wrap DateTime instances. Implements form of to_s used
+    # to render times in output of `read` subcommand.
+    #
+    class ReadDisplay
+      def initialize(date_time)
+        @date_time = date_time
+      end
+
+      def to_s
+        if CLIOptions.instance[:military]
+          @date_time.strftime("%H:%M")
+        else
+          @date_time.strftime("%I:%M %p")
+        end
+      end
+    end
+  end
+end

data/lib/piece_of_wax/date_time_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "piece_of_wax/cli_options"
+require "time"
+
+module PieceOfWax
+  #
+  # Implements helper methods related to Date/Time
+  #
+  module DateTimeHelper
+    def self.safe_parse(arg)
+      # NOTE: calling to_s so method is safe for non-string args
+      str = arg.to_s
+      begin
+        Time.parse(str)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    def self.current_date
+      # NOTE: Possible that current_date returns two different values over course of
+      #       same piece_of_wax invocation (if run at midnight.) I consider this
+      #       to be a major edge case with minimal consequences, so I'm not
+      #       going to the trouble of memoizing at this point. - Ben S.
+      Time.now.to_date
+    end
+
+    def self.current_time
+      Time.now
+    end
+  end
+end

data/lib/piece_of_wax/file_io.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PieceOfWax
+  #
+  # A FileIO instance represents a file. Abstracts reading from and writing to the file system.
+  #
+  class FileIO
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def read
+      File.read(@filename)
+    rescue Errno::ENOENT
+      nil
+    end
+
+    def overwrite_with(str)
+      File.open(@filename, "w") do |f|
+        f.write(str)
+      end
+    end
+  end
+end

data/lib/piece_of_wax/logfile.rb

@@ -1,32 +1,44 @@
-require 'erb'
-require 'json'
-require 'piece_of_wax/file_io'
-require 'piece_of_wax/output_line/activity'
-require 'piece_of_wax/output_line/date'
+# frozen_string_literal: true
+
+require "erb"
+require "json"
+require "piece_of_wax/file_io"
+require "piece_of_wax/output_line/activity"
+require "piece_of_wax/output_line/date"
 
 module PieceOfWax
+  #
+  # A Logfile instance represents a specific type of file used by piece_of_wax to
+  # store logged time (a "time log.") A time log stores information for a single day,
+  # which is why a date must be passed to the Logfile constructor.
+  #
   class Logfile
     def initialize(date)
-      filename = "%s.txt" % date.strftime("%y%m%d")
+      filename = format("%s.txt", date.strftime("%y%m%d"))
       @file_io = FileIO.new(filename)
     end
 
     def contents
-      return unless raw_content = @file_io.read
+      return [] unless (raw_content = @file_io.read)
+
       JSON.parse(raw_content)
     end
 
+    def any_contents?
+      contents.any?
+    end
+
     def add_activity(time, description)
-      data =
-        { datetime: time, description: description }
-      obj =
-        if contents
-          contents.insert(proper_index(time), data)
-        else
-          [data]
-        end
-      str = obj.to_json
-      @file_io.overwrite_with(str)
+      data = { datetime: time, description: description }
+      index = proper_index(time)
+      json_str = contents.insert(index, data).to_json
+      @file_io.overwrite_with(json_str)
+    end
+
+    def edit_activity(index, description)
+      updated_contents = contents.tap { |c| c[index]["description"] = description }
+      json_str = updated_contents.to_json
+      @file_io.overwrite_with(json_str)
     end
 
     def to_s
@@ -36,7 +48,7 @@ module PieceOfWax
           <% contents.each_cons(2).map do |line1, line2| %>
           <%= OutputLine::Activity.new(line1['datetime'], line2['datetime'], line1['description']) %>
           <% end.join("\n") %>
-          <%= OutputLine::Activity.new(last_entry['datetime'], "17:45:00 -0500", last_entry['description']) %>
+          <%= OutputLine::Activity.new(last_entry['datetime'], quitting_time, last_entry['description']) %>
         ERB
       # Unsure why ERB is inserting the double linebreaks after each
       # iteration of `contents.each_cons(2)`. For now, subbing single linebreak
@@ -48,9 +60,9 @@ module PieceOfWax
 
     def proper_index(time)
       contents.each_with_index do |line, i|
-        return i if Time.parse(line['datetime']) > time
+        return i if Time.parse(line["datetime"]) > time
       end
-      return contents.length
+      contents.length
     end
 
     def first_entry
@@ -60,5 +72,9 @@ module PieceOfWax
     def last_entry
       contents.last
     end
+
+    def quitting_time
+      CLIOptions.instance[:'quitting-time']
+    end
   end
 end

data/lib/piece_of_wax/output_line/activity.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "piece_of_wax/date_time_helper"
+require "piece_of_wax/date_time_decorator/read_display"
+
+module PieceOfWax
+  module OutputLine
+    #
+    # An Activity instance represents a single logged activity, rendered as a line of
+    # `read` subcommand output.
+    #
+    class Activity
+      def initialize(start_time_str, end_time_str, description)
+        @start_time = DateTimeDecorator::ReadDisplay.new(DateTimeHelper.safe_parse(start_time_str))
+        @end_time = DateTimeDecorator::ReadDisplay.new(DateTimeHelper.safe_parse(end_time_str))
+        @description = description
+      end
+
+      def to_s
+        "#{@start_time}-#{@end_time}    - #{@description}"
+      end
+    end
+  end
+end

data/lib/piece_of_wax/output_line/date.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "piece_of_wax/date_time_helper"
+
+module PieceOfWax
+  module OutputLine
+    #
+    # A Date instance represents the date of a time log (see Logfile,) rendered as a line of
+    # `read` subcommand output.
+    #
+    class Date
+      def initialize(datetime_str)
+        @date = DateTimeHelper.safe_parse(datetime_str)
+      end
+
+      def to_s
+        @date.strftime("%-m/%-d/%y")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piece_of_wax
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc6
 platform: ruby
 authors:
 - Ben Stegeman
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.88.0
 description: ''
 email: bstegeman17@gmail.com
 executables:
@@ -117,7 +131,14 @@ extra_rdoc_files: []
 files:
 - bin/piece_of_wax
 - lib/piece_of_wax.rb
+- lib/piece_of_wax/cli_options.rb
+- lib/piece_of_wax/date_time_decorator/error_message_display.rb
+- lib/piece_of_wax/date_time_decorator/read_display.rb
+- lib/piece_of_wax/date_time_helper.rb
+- lib/piece_of_wax/file_io.rb
 - lib/piece_of_wax/logfile.rb
+- lib/piece_of_wax/output_line/activity.rb
+- lib/piece_of_wax/output_line/date.rb
 homepage: 
 licenses:
 - MIT