journal-cli 1.0.34 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29a2bf23b86563b74a924d299a9abcced78ee4ea461dbbd537e49682ccbe0d75
-  data.tar.gz: 9790b487cce722f84c8b8e052d3cc558a84684ea37df3b33091b80f871b5a9b6
+  metadata.gz: 1f62f54f397dd0589f5ba2584df91129cef9ed40d83941d7c07bb82b8164392e
+  data.tar.gz: df3046ab0fc6ae4436f4b99ede207fd8bef86ac8e6ea3b56661e8c678351e3a2
 SHA512:
-  metadata.gz: e8f3ae5b2feec8f3083fdbe9842b8ca0dcb0790419b12b748157e36919125f0533108cc23abd5ae9cf7f1eaed1ca960c332a3f8acaa6c46262daf9bf1bd534f4
-  data.tar.gz: 8bec17925e1c96320d31d6f71085d8e17996323c5d923fd3b71372096d28bbfda997b3699f909776f5c58729aa927741cb1e5ab2308e5a576a84b952b527605b
+  metadata.gz: 57a2347a3cf429821d26d3d99b7cc849bcd6225cb63cf74591dac549c6609d6ec1056a2e6659627d27aba13eddcb5a52175fb76ca9505c0782e933a0643c5a1d
+  data.tar.gz: 7549d15f6795599ea695f2cc99f8faa8b02176bdc1a5328565efa4777a93d3646b83face27b686aa39fb23ec1ca15975def359a879ed138704d0c0300d0f2ad6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 1.0.35
+
+2024-06-22 11:45
+
+#### IMPROVED
+
+- Display answers to prompt when filling out entry
+- Launch Day One before trying to add entry. Day One's database frequently gets updated and the command line tool will throw an error if Day One hasn't been launched. So launch it hidden in the background, and then quit if it wasn't running to begin with. This will cause the database to update.
+- Method documentation
+
 ### 1.0.34
 
 2024-06-22 11:01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    journal-cli (1.0.34)
+    journal-cli (1.0.35)
       chronic (~> 0.10, >= 0.10.2)
       tty-reader (~> 0.9, >= 0.9.0)
       tty-which (~> 0.5, >= 0.5.0)

data/lib/journal-cli/array.rb

@@ -1,10 +1,23 @@
 # frozen_string_literal: true
 
+##
+## Array helpers
+##
 class ::Array
+  ##
+  ## Find the shortest element in an array of strings
+  ##
+  ## @return     [String] shortest element
+  ##
   def shortest
     inject { |memo, word| (memo.length < word.length) ? memo : word }
   end
 
+  ##
+  ## Find the longest element in an array of strings
+  ##
+  ## @return     [String] longest element
+  ##
   def longest
     inject { |memo, word| (memo.length > word.length) ? memo : word }
   end

data/lib/journal-cli/checkin.rb

@@ -3,6 +3,11 @@ module Journal
   class Checkin
     attr_reader :key, :date, :data, :config, :journal, :sections, :title, :output
 
+    ##
+    ## Initialize a new checkin using a configured journal
+    ##
+    ## @param      journal  [Journal] The journal
+    ##
     def initialize(journal)
       @key = journal
       @output = []
@@ -19,26 +24,51 @@ module Journal
       @title = @journal["title"].sub(/%M/, meridian)
     end
 
+    ##
+    ## Add a title (Markdown) to the output
+    ##
+    ## @param      string  [String] The string
+    ##
     def add_title(string)
       @output << "\n## #{string}\n" unless string.nil?
     end
 
+    ##
+    ## Add a question header (Markdown) to the output
+    ##
+    ## @param      string  [String] The string
+    ##
     def header(string)
       @output << "\n##### #{string}\n" unless string.nil?
     end
 
+    ##
+    ## Add a section header (Markdown) to the output
+    ##
+    ## @param      string  [String] The string
+    ##
     def section(string)
       @output << "\n###### #{string}\n" unless string.nil?
     end
 
+    ##
+    ## Add a newline to the output
+    ##
     def newline
       @output << "\n"
     end
 
+    ##
+    ## Add a horizontal rule (Markdown) to the output
+    ##
     def hr
       @output << "\n* * * * * *\n"
     end
 
+    ##
+    ## Finalize the checkin, saving data to JSON, Day One,
+    ## and Markdown as configured
+    ##
     def go
       @sections.each { |key, section| @data[key] = section }
 
@@ -57,11 +87,31 @@ module Journal
       end
     end
 
+    ##
+    ## Launch Day One and quit if it wasn't running
+    ##
+    def launch_day_one
+      # Launch Day One to ensure database is up-to-date
+      # test if Day One is open
+      running = !`ps ax | grep "/MacOS/Day One" | grep -v grep`.strip.empty?
+      # -g do not bring app to foreground
+      # -j launch hidden
+      `/usr/bin/open -gj -a "Day One"`
+      # quit if it wasn't running
+      `osascript -e 'tell app "Day One" to quit'` if !running
+    end
+
+    ##
+    ## Save journal entry to Day One using the command line tool
+    ##
     def save_day_one_entry
       unless TTY::Which.exist?("dayone2")
         Journal.notify("{br}Day One CLI not installed, no Day One entry created")
         return
       end
+
+      launch_day_one
+
       @date.localtime
       cmd = ["dayone2"]
       cmd << %(-j "#{@journal["journal"]}") if @journal.key?("journal")
@@ -71,6 +121,9 @@ module Journal
       Journal.notify("{bg}Entered one entry into Day One")
     end
 
+    ##
+    ## Save entry to an existing Markdown file
+    ##
     def save_single_markdown
       dir = if @journal.key?("entries_folder")
         File.join(File.expand_path(@journal["entries_folder"]), "entries")
@@ -93,6 +146,9 @@ module Journal
       Journal.notify "{bg}Added new entry to {bw}#{target}"
     end
 
+    ##
+    ## Save journal entry to daily Markdown file
+    ##
     def save_daily_markdown
       dir = if @journal.key?("entries_folder")
         File.join(File.expand_path(@journal["entries_folder"]), "entries")
@@ -114,6 +170,9 @@ module Journal
       Journal.notify "{bg}Saved daily Markdown to {bw}#{target}"
     end
 
+    ##
+    ## Save journal entry to an new individual Markdown file
+    ##
     def save_individual_markdown
       dir = if @journal.key?("entries_folder")
         File.join(File.expand_path(@journal["entries_folder"]), "entries")

data/lib/journal-cli/data.rb

@@ -10,6 +10,11 @@ module Journal
       super
     end
 
+    ##
+    ## Convert Data object to a hash
+    ##
+    ## @return     [Hash] Data representation of the object.
+    ##
     def to_data
       output = {}
       @questions.each do |q|

data/lib/journal-cli/question.rb

@@ -33,20 +33,22 @@ module Journal
 
       return nil unless @condition && condition
 
-      case @type
-      when /^int/i
-        read_number(integer: true)
-      when /^(float|num)/i
-        read_number
-      when /^(text|string|line)/i
-        read_line
-      when /^(weather|forecast)/i
-        Weather.new(Journal.config["weather_api"], Journal.config["zip"], Journal.config["temp_in"])
-      when /^multi/i
-        read_lines
-      when /^(date|time)/i
-        read_date
-      end
+      res = case @type
+            when /^int/i
+              read_number(integer: true)
+            when /^(float|num)/i
+              read_number
+            when /^(text|string|line)/i
+              read_line
+            when /^(weather|forecast)/i
+              Weather.new(Journal.config["weather_api"], Journal.config["zip"], Journal.config["temp_in"])
+            when /^multi/i
+              read_lines
+            when /^(date|time)/i
+              read_date
+            end
+      Journal.notify("{dw}#{prompt}: {dy}#{res}{x}".x)
+      res
     end
 
     private

data/lib/journal-cli/string.rb

@@ -2,6 +2,12 @@
 
 # String helpers
 class ::String
+
+  ##
+  ## Parse and test a condition
+  ##
+  ## @return     [Boolean] whether test passed
+  ##
   def parse_condition
     condition = dup
     time_rx = /(?<comp>[<>=]{1,2}|before|after) +(?<time>(?:noon|midnight|[0-9]+) *(?:am|pm)?)$/i

data/lib/journal-cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Journal
-  VERSION = '1.0.34'
+  VERSION = '1.0.35'
 end

data/lib/journal-cli/weather.rb

@@ -4,6 +4,13 @@ module Journal
   class Weather
     attr_reader :data
 
+    ##
+    ## Initialize the weather object, contacting API and parsing out conditions and forecast
+    ##
+    ## @param      api      [String] The api key
+    ## @param      zip      [String] The zip code
+    ## @param      temp_in  [String] F or C
+    ##
     def initialize(api, zip, temp_in)
       Journal.date.localtime
       res = if Journal.date.strftime("%Y-%m-%d") == Time.now.strftime("%Y-%m-%d")
@@ -43,13 +50,13 @@ module Journal
 
       hours = forecast["hour"]
       temps = [
-        {temp: hours[8][temp_key], condition: hours[8]["condition"]["text"]},
-        {temp: hours[10][temp_key], condition: hours[10]["condition"]["text"]},
-        {temp: hours[12][temp_key], condition: hours[12]["condition"]["text"]},
-        {temp: hours[14][temp_key], condition: hours[14]["condition"]["text"]},
-        {temp: hours[16][temp_key], condition: hours[16]["condition"]["text"]},
-        {temp: hours[18][temp_key], condition: hours[18]["condition"]["text"]},
-        {temp: hours[19][temp_key], condition: hours[20]["condition"]["text"]}
+        { temp: hours[8][temp_key], condition: hours[8]["condition"]["text"] },
+        { temp: hours[10][temp_key], condition: hours[10]["condition"]["text"] },
+        { temp: hours[12][temp_key], condition: hours[12]["condition"]["text"] },
+        { temp: hours[14][temp_key], condition: hours[14]["condition"]["text"] },
+        { temp: hours[16][temp_key], condition: hours[16]["condition"]["text"] },
+        { temp: hours[18][temp_key], condition: hours[18]["condition"]["text"] },
+        { temp: hours[19][temp_key], condition: hours[20]["condition"]["text"] }
       ]
 
       @data = {
@@ -64,6 +71,11 @@ module Journal
       }
     end
 
+    ##
+    ## Convert weather object to hash
+    ##
+    ## @return     [Hash] Data representation of the object.
+    ##
     def to_data
       {
         high: @data[:high],
@@ -73,22 +85,52 @@ module Journal
       }
     end
 
+    ##
+    ## Get moon phase
+    ##
+    ## @return     [String] moon phase
+    ##
     def moon
       @data[:moon_phase]
     end
 
+    ##
+    ## Get current conditon
+    ##
+    ## @return     [String] condition as string (54 and
+    ##             Sunny)
+    ##
     def current
       "#{@data[:temp]} and #{@data[:current_condition]}"
     end
 
+    ##
+    ## Get daily forecast
+    ##
+    ## @return     [String] daily forecast as string (Sunny
+    ##             65/80)
+    ##
     def forecast
       "#{@data[:condition]} #{@data[:high]}/#{@data[:low]}"
     end
 
+    ##
+    ## Weather condition and forecast
+    ##
+    ## @return     [String] string representation of the
+    ##             weather object.
+    ##
     def to_s
       "#{@data[:temp].round} and #{@data[:current_condition]} (#{@data[:high].round}/#{@data[:low].round})"
     end
 
+    ##
+    ## Markdown representation of data, including hourly
+    ## forecast and conditions
+    ##
+    ## @return     [String] Markdown representation of the
+    ##             weather object.
+    ##
     def to_markdown
       output = []
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.34
+  version: 1.0.35
 platform: ruby
 authors:
 - Brett Terpstra