piece_of_wax 0.0.2 → 1.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683908a54cb7a603677d40b86d375486d3c32f52a0d6630ceb24ac1c91a953eb
-  data.tar.gz: 6eeb3aef9b284a8086a32ab70248b4ea53bfd9614e417293734fc2f49bd8ccc2
+  metadata.gz: 0fdf0186e07e8c9137374525a9befb04f41b30be7dbfe81e65c2d89775a171b2
+  data.tar.gz: 475ee015973ef306855f15574fe82334c95ccbd9dd0a4925224d96a0595ca2ee
 SHA512:
-  metadata.gz: 4da0542b0d656c49f6278fedfa449966a1a07d0fda7fc3c02d33679b3108605d614237c1ae7c524d498cfc6d3b50ca14439e52dad8a7175baf0bc37a20bf5f3a
-  data.tar.gz: d610bdae2c2fa0125e1691ba3bc83d7f5051aa5a6455985ac69055d45996a4dcb46ee1a2410f9639c271049513ff91dd485d08a01addccf41f28f6eacf554fe0
+  metadata.gz: e18a182873c378b85d385abec297c2041a640432a377e9e91d458f15abe2c2f4b63e03b235bbc343acc61806351f85687d9d762c783f7e2f594005a0669b8646
+  data.tar.gz: 6441d89f22d93c54865c1e94f0398db26a4b6856f356699e77b8c599f92ba81dd22e897fd5443c74d307748915baa51f74fb35502376ef051742d00054151141

data/bin/piece_of_wax

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

data/lib/piece_of_wax.rb

@@ -1,68 +1,66 @@
-require "thor"
-require "date"
-
-class PieceOfWax < Thor
-  desc "activity _activity_", "log activity"
-  def activity(x)
-    write_to_file("#{Time.now} - #{x}")
-    puts "wrote #{x} to file"
-  end
+# frozen_string_literal: true
 
-  desc "read [date]", "print activities on given [date] (yesterday by default)"
-  def read(date = Date.today.strftime('%Y-%m-%d'))
-    output =
-      begin
-        generate_output(File.open(filename(date)).readlines)
-      rescue Errno::ENOENT
-        "Sorry, I couldn't find any logs for #{print_date(date)}."
-      end
-    puts output
-  end
-
-  private
+require "json"
+require "piece_of_wax/cli_options"
+require "piece_of_wax/date_time_helper"
+require "piece_of_wax/date_time_decorator/error_message_display"
+require "piece_of_wax/logfile"
+require "thor"
 
-  def write_to_file(str)
-    today = Time.now.strftime("%y%m%d")
-    File.open("#{today}.txt", "a+") do |f|
-      f.puts(str)
+module PieceOfWax
+  #
+  # Implements command line interface. Each public method corresponds to a `piece_of_wax`
+  # subcommand.
+  #
+  class CLI < Thor
+    desc 'activity "_activity_"', "log activity"
+    option :time, aliases: :t, desc: "time when activity was started"
+    def activity(*str)
+      CLIOptions.instance.set(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
-  end
-
-  def filename(date)
-    "%s.txt" % Date.parse(date).strftime("%y%m%d")
-  end
 
-  def print_date(date)
-    if date == Date.today.prev_day
-      'yesterday'
-    else
-      date
+    desc 'edit "_activity_"', "edit activity"
+    option :n, default: "1", desc: "the activity to edit, 1 being the most recently-logged"
+    def edit(*str)
+      CLIOptions.instance.set(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
-  end
 
-  def generate_output(lines)
-    date = date_format(lines[0].split(' ')[0])
-    result =
-      lines.each_cons(2).reduce([date]) do |output, (line1, line2)|
-        output << output_line(line1, line2)
+    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 = "")
+      CLIOptions.instance.set(options)
+      date = DateTimeHelper.safe_parse(date_str) || DateTimeHelper.current_date
+      logfile = Logfile.new(date)
+      if logfile.any_contents?
+        $stdout.puts logfile
+      else
+        warn "Sorry, I couldn't find any logs for #{DateTimeDecorator::ErrorMessageDisplay.new(date)}."
       end
-    result << output_line(lines.last, "#{date} 05:45:00 -0500 - #{lines.last.split(' - ')[1]}")
-  end
-
-  def output_line(line1, line2)
-    date_info1, activity1 = line1.split(' - ')
-    date_info2, _activity2 = line2.split(' - ')
-    _date1, time1, _time_delta1 = date_info1.split(' ')
-    _date2, time2, _time_delta2 = date_info2.split(' ')
-    "#{time_format(time1)}-#{time_format(time2)}    - #{activity1}"
-  end
+    end
 
-  def date_format(str)
-    year, month, day = str.split('-').map(&:to_i)
-    Date.new(year, month, day).strftime('%-m/%-d/%y')
-  end
+    private
 
-  def time_format(str)
-    str.split(':').first(2).join(':')
+    def exit_on_failure?
+      true
+    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

@@ -0,0 +1,80 @@
+# 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 = format("%s.txt", date.strftime("%y%m%d"))
+      @file_io = FileIO.new(filename)
+    end
+
+    def contents
+      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 }
+      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
+      output =
+        ERB.new(<<~ERB).result(binding)
+          <%= OutputLine::Date.new(first_entry['datetime']) %>
+          <% 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'], 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
+      # to eliminate doubles.
+      output.gsub("\n\n", "\n")
+    end
+
+    private
+
+    def proper_index(time)
+      contents.each_with_index do |line, i|
+        return i if Time.parse(line["datetime"]) > time
+      end
+      contents.length
+    end
+
+    def first_entry
+      contents.first
+    end
+
+    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: 0.0.2
+  version: 1.0.0.rc5
 platform: ruby
 authors:
 - Ben Stegeman
@@ -14,30 +14,114 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
 description: ''
 email: bstegeman17@gmail.com
 executables:
@@ -47,6 +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
@@ -62,9 +154,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6