piece_of_wax 1.0.0.rc4 → 1.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b92e1cfe6301bf02d152496ddf9520477d8b51923acf0ef75cbfdf3d26e40e89
-  data.tar.gz: 8ce76810acf032cb480745549bf17723001fbf0e3ea0721b55644b2007f52ad6
+  metadata.gz: 0fdf0186e07e8c9137374525a9befb04f41b30be7dbfe81e65c2d89775a171b2
+  data.tar.gz: 475ee015973ef306855f15574fe82334c95ccbd9dd0a4925224d96a0595ca2ee
 SHA512:
-  metadata.gz: 5de817f46214d1fa70d63df75d46c0c2967765642be08098387cb145aa8cea8c9e15b20719db4e8042b4c77eadad3e533dde90784261cab6350421ba7fcef93d
-  data.tar.gz: 5af1c5b2f8bab1142db6c5a7a76f0764e1ac445e1f37f19ef069553c066f80e29bd9c71a8da2b1f50464d6563cc69451bfb0ccd4f0918d8c40e2789d1f3e879b
+  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 'piece_of_wax'
+require "piece_of_wax"
 PieceOfWax::CLI.start(ARGV)

data/lib/piece_of_wax.rb

@@ -1,48 +1,59 @@
+# 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"
-    option :time, aliases: :t, desc: 'time when activity was started'
+    option :time, aliases: :t, desc: "time when activity was started"
     def activity(*str)
       CLIOptions.instance.set(options)
-      time = DateTime.safe_parse(CLIOptions.instance[:time]) || DateTime.current_time
-      description = str.join(' ')
-      Logfile.new(DateTime.current_date).add_activity(time, description)
+      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 'edit "_activity_"', "edit activity"
-    option :n, default: '1', desc: 'the activity to edit, 1 being the most recently-logged'
+    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(' ')
+      description = str.join(" ")
       index = (0 - CLIOptions.instance[:n].to_i)
-      logfile = Logfile.new(DateTime.current_date)
+      logfile = Logfile.new(DateTimeHelper.current_date)
       if logfile.contents[index]
         logfile.edit_activity(index, description)
         $stdout.puts "wrote #{description} to file"
       else
-        $stderr.puts 'activity referenced by "n" option does not exist'
+        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 = '')
+    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 = DateTime.safe_parse(date_str) || DateTime.current_date
+      date = DateTimeHelper.safe_parse(date_str) || DateTimeHelper.current_date
       logfile = Logfile.new(date)
       if logfile.any_contents?
         $stdout.puts logfile
       else
-        $stderr.puts "Sorry, I couldn't find any logs for #{DateTimeDecorator::ErrorMessageDisplay.new(date)}."
+        warn "Sorry, I couldn't find any logs for #{DateTimeDecorator::ErrorMessageDisplay.new(date)}."
       end
     end
 

data/lib/piece_of_wax/cli_options.rb

@@ -1,7 +1,13 @@
-require 'forwardable'
-require 'singleton'
+# 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
@@ -11,7 +17,8 @@ module PieceOfWax
     end
 
     def set(opts)
-      fail 'CLIOptions is an immutable singleton; #set can only be called once per program execution' if options.any?
+      raise "CLIOptions is an immutable singleton; #set can only be called once per program execution" if options.any?
+
       @options = opts
     end
 

data/lib/piece_of_wax/date_time_decorator/error_message_display.rb

@@ -1,5 +1,13 @@
+# 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
@@ -7,12 +15,12 @@ module PieceOfWax
 
       def to_s
         case @date_time.to_date
-        when @date_time.class.current_date
-          'today'
-        when @date_time.class.current_date.prev_day
-          'yesterday'
+        when DateTimeHelper.current_date
+          "today"
+        when DateTimeHelper.current_date.prev_day
+          "yesterday"
         else
-          @date_time.strftime('%Y-%-m-%-d')
+          @date_time.strftime("%Y-%-m-%-d")
         end
       end
     end

data/lib/piece_of_wax/date_time_decorator/read_display.rb

@@ -1,5 +1,11 @@
+# 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
@@ -7,9 +13,9 @@ module PieceOfWax
 
       def to_s
         if CLIOptions.instance[:military]
-          @date_time.strftime('%H:%M')
+          @date_time.strftime("%H:%M")
         else
-          @date_time.strftime('%I:%M %p')
+          @date_time.strftime("%I:%M %p")
         end
       end
     end

data/lib/piece_of_wax/{date_time.rb → date_time_helper.rb}

@@ -1,13 +1,18 @@
-require 'piece_of_wax/cli_options'
-require 'time'
+# frozen_string_literal: true
+
+require "piece_of_wax/cli_options"
+require "time"
 
 module PieceOfWax
-  class DateTime < ::Time
+  #
+  # 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
-        parse(str)
+        Time.parse(str)
       rescue ArgumentError
         nil
       end

data/lib/piece_of_wax/file_io.rb

@@ -1,15 +1,18 @@
+# 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
-      begin
-        File.read(@filename)
-      rescue Errno::ENOENT
-        nil
-      end
+      File.read(@filename)
+    rescue Errno::ENOENT
+      nil
     end
 
     def overwrite_with(str)

data/lib/piece_of_wax/logfile.rb

@@ -1,18 +1,26 @@
-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
 
@@ -28,7 +36,7 @@ module PieceOfWax
     end
 
     def edit_activity(index, description)
-      updated_contents = contents.tap { |c| c[index]['description'] = description }
+      updated_contents = contents.tap { |c| c[index]["description"] = description }
       json_str = updated_contents.to_json
       @file_io.overwrite_with(json_str)
     end
@@ -52,7 +60,7 @@ 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
       contents.length
     end

data/lib/piece_of_wax/output_line/activity.rb

@@ -1,12 +1,18 @@
-require 'piece_of_wax/date_time'
+# 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(DateTime.safe_parse(start_time_str))
-        @end_time = DateTimeDecorator::ReadDisplay.new(DateTime.safe_parse(end_time_str))
+        @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
 

data/lib/piece_of_wax/output_line/date.rb

@@ -1,14 +1,20 @@
-require 'piece_of_wax/date_time'
+# 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 = DateTime.safe_parse(datetime_str)
+        @date = DateTimeHelper.safe_parse(datetime_str)
       end
 
       def to_s
-        @date.strftime('%-m/%-d/%y')
+        @date.strftime("%-m/%-d/%y")
       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.rc4
+  version: 1.0.0.rc5
 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
@@ -95,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         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:
@@ -118,9 +132,9 @@ files:
 - bin/piece_of_wax
 - lib/piece_of_wax.rb
 - lib/piece_of_wax/cli_options.rb
-- lib/piece_of_wax/date_time.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