journal-cli 1.0.22 → 1.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1255e03e2644a0bb96f72622c8815595f41bec61e1add52529b697097f4b94f6
-  data.tar.gz: 613eca7fbaccd6536b3edd23da7160c337ad1bf7dc7dc509b41ddf85e788c478
+  metadata.gz: 110b0fe8610e39052c3f85c417739821f66103cd0457a23a03188a158062962f
+  data.tar.gz: b56dfb4649456dd53e22aa86fece669f8d162fd6048537e06ba8c6aeb0db61c1
 SHA512:
-  metadata.gz: 34c25cc5c7c076f47dfa2fedd6bd7434dc8b7268b2662cef74bdcabbd6fdbe99b1a3882ad4c129e6c5434b169fd0d5a377bbeef78207e993b026125339386a96
-  data.tar.gz: 3a1fccc6120ed77cc602a1448a9949b49aa42ea658d3c93d11de7d77aad9a6bc0e707ac125f0faaa93bad5bb3de2b921fe35f57afd1a112a01982ce5bc9b01b6
+  metadata.gz: 237a1faa0d7d4acfb0bb1d0c3775b46055529e432dbba25e38b723cd5cab39e68db7796d824c870739f8fa9b28f2c1d040df1d4fb84bd3e57581cc18ba931ea7
+  data.tar.gz: cc8e68cf73df3bf13a71b2eb9126a136dd9f989a869c519dece7f733e1a89dfd5552626fc249bf7c6bc2ea95ee2a1a23836a6c8ed410202b1d4578b6be8d655e

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 1.0.24
+
+2023-09-20 09:12
+
+### 1.0.23
+
+2023-09-20 08:30
+
+#### NEW
+
+- Question types weather.forecast and weather.current allow more specific weather entry types
+- Time-based conditions for questions and sections (`condition: before noon` or `condition: < 12pm`)
+
+#### FIXED
+
+- Test for existence of dayone2 binary before attempting to write a Day One entry, provide error message
+
 ### 1.0.22
 
 2023-09-18 10:23

data/Gemfile.lock

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

data/README.md

@@ -52,6 +52,10 @@ This file contains a YAML definition of your journal. Each journal gets a top-le
 
 You can include weather data automatically by setting a question type to 'weather'. In order for this to work, you'll need to define `zip` and `weather_api` keys. `zip` is just your zip code, and `weather_api` is a key from WeatherAPI.com. Sign up [here](https://www.weatherapi.com/) for a free plan, and then visit the [profile page](https://www.weatherapi.com/my/) to see your API key at the top.
 
+If a question type is set to `weather.forecast`, only the predicted condition, high, and low will be included in the JSON data for the question. A full printout of hourly temps will be included in the Markdown/Day One output.
+
+If the question type is `weather.current`, only the current condition and temperature will be recorded to the JSON, and a string containing "[TEMP] and [CONDITION]" (e.g. "64 and Sunny") will be recorded to Markdown/Day One for the question.
+
 ### Journal Configuration
 
 Edit the file at `~/.config/journal/journals.yaml` following this structure:
@@ -96,9 +100,12 @@ journals: # required key
       - title: Weather # Title of the section (will create template sections in Day One)
         key: weather # the key to use in the structured data, will contain all of the answers
         questions: # required key
-          - prompt: Current weather # The prompt shown on the command line, will also become a header in the journal entries (Markdown, Day One)
+          - prompt: Current Weather
+            key: weather.current
+            type: weather.current
+          - prompt: Weather Forecast # The prompt shown on the command line, will also become a header in the journal entries (Markdown, Day One)
             key: weather.forecast # if a key contains a dot, it will create nested data, e.g. `{ 'weather': { 'forecast': data } }`
-            type: weather # Set this to weather for weather data
+            type: weather.forecast # Set this to weather for weather data
       - title: Health # New section
         key: health 
         questions:
@@ -141,10 +148,18 @@ A question `type` can be one of:
 - `text` or `string` will request a single-line string, submitted on return
 - `multiline` for multiline strings (opens a readline editor, use ctrl-d to save)
 - `weather` will just insert current weather data with no prompt
+  * `weather.forecast` will insert just the forecast
+  * `weather.current` will insert just the current temperature and condition
 - `number` or `float` will request numeric input, stored as a float (decimal)
 - `integer` will convert numeric input to the nearest integer
 - `date` will request a natural language date which will be parsed into a date object
 
+### Conditional Questions
+
+You can have a question only show up based on conditions. Currently the only condition is time based. Just add a key called `condition` to the question definition, then include a natural language string like `before noon` or `after 3pm`. If the condition is matched, then the question will be displayed, otherwise it will be skipped and its data entry in the JSON will be null.
+
+Conditions can be applied to individual questions, or to entire sections, depending on where the `condition` key is placed.
+
 ### Naming Keys
 
 If you want data stored in a nested object, you can set a question type to `dictionary` and set the prompt to `null` (or just leave the key out), but give it a key that will serve as the parent in the object. Then in the nested questions, give them a key in the dot format `[PARENT_KEY].[CHILD_KEY]`. Section keys automatically nest their questions, but if you want to go deeper, you could have a question with the key `health` and type `dictionary`, then have questions with keys like `health.rating` and `health.notes`. If the section key was `status`, the resulting dictionary would look like this in the JSON:

data/bin/journal

@@ -4,6 +4,8 @@ $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
 require 'journal-cli'
 require 'optparse'
 
+trap('SIGINT') { exit! }
+
 module Journal
   class << self
     def usage
@@ -33,8 +35,10 @@ module Journal
                Time.now
              end
 
+      Journal.date = date
+
       if Journal.config['journals'].key?(journal)
-        checkin = Journal::Checkin.new(journal, date)
+        checkin = Journal::Checkin.new(journal)
         checkin.go
       else
         puts "Journal #{journal} not found"

data/lib/journal-cli/checkin.rb

@@ -3,10 +3,10 @@ module Journal
   class Checkin
     attr_reader :key, :date, :data, :config, :journal, :sections, :title, :output
 
-    def initialize(journal, date)
+    def initialize(journal)
       @key = journal
       @output = []
-      @date = date
+      @date = Journal.date
       @date.localtime
 
       raise StandardError, "No journal with key #{@key} found" unless Journal.config['journals'].key? @key
@@ -36,7 +36,7 @@ module Journal
     end
 
     def hr
-      @output << "\n---\n"
+      @output << "\n* * * * * *\n"
     end
 
     def go
@@ -58,6 +58,11 @@ module Journal
     end
 
     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
+      @date.localtime
       cmd = ['dayone2']
       cmd << %(-j "#{@journal['journal']}") if @journal.key?('journal')
       cmd << %(-t #{@journal['tags'].join(' ')}) if @journal.key?('tags')
@@ -128,11 +133,17 @@ module Journal
     end
 
     def print_answer(prompt, type, key, data)
+      return if data.nil? || !data.key?(key)
+
       case type
       when /^(weather|forecast)/
         header prompt
-        @output << data[key].to_markdown
-        hr
+        @output << case type
+                   when /current$/
+                     data[key].current
+                   else
+                     data[key].to_markdown
+                   end
       when /^(int|num)/
         @output << "#{prompt}: #{data[key]}  " unless data[key].nil?
       when /^date/
@@ -158,7 +169,14 @@ module Journal
           v.localtime
           data[k] = v.strftime('%Y-%m-%d %H:%M')
         when /Weather/
-          data[k] = v.to_s
+          data[k] = case k
+                    when /current$/
+                      v.current
+                    when /forecast$/
+                      data[k] = v.forecast
+                    else
+                      data[k] = v.to_s
+                    end
         else
           data[k] = v
         end
@@ -240,11 +258,18 @@ module Journal
             v.each do |key, value|
               result = case value.class.to_s
                        when /Weather/
-                         {
-                           'high' => value.data[:high],
-                           'low' => value.data[:low],
-                           'condition' => value.data[:condition]
-                         }
+                         if key =~ /current$/
+                           {
+                             'temp' => value.data[:temp],
+                             'condition' => value.data[:current_condition]
+                           }
+                         else
+                           {
+                             'high' => value.data[:high],
+                             'low' => value.data[:low],
+                             'condition' => value.data[:condition]
+                           }
+                         end
                        else
                          value
                        end

data/lib/journal-cli/question.rb

@@ -3,7 +3,7 @@
 module Journal
   # Individual question
   class Question
-    attr_reader :key, :type, :min, :max, :prompt, :secondary_prompt, :gum
+    attr_reader :key, :type, :min, :max, :prompt, :secondary_prompt, :gum, :condition
 
     ##
     ## Initializes the given question.
@@ -20,6 +20,7 @@ module Journal
       @prompt = question['prompt'] || nil
       @secondary_prompt = question['secondary_prompt'] || nil
       @gum = TTY::Which.exist?('gum')
+      @condition = question.key?('condition') ? question['condition'].parse_condition : true
     end
 
     ##
@@ -27,9 +28,11 @@ module Journal
     ##
     ## @return     [Number, String] the response based on @type
     ##
-    def ask
+    def ask(condition)
       return nil if @prompt.nil?
 
+      return nil unless @condition && condition
+
       case @type
       when /^int/i
         read_number(integer: true)
@@ -126,6 +129,7 @@ module Journal
     ##
     ##
     def read_number_gum
+      trap('SIGINT') { exit! }
       res = `gum input --placeholder "#{@min}-#{@max}"`.strip
       return nil if res.strip.empty?
 
@@ -140,6 +144,7 @@ module Journal
     ## @return     [Number] integer response
     ##
     def read_line_tty
+      trap('SIGINT') { exit! }
       reader = TTY::Reader.new
       res = reader.read_line('>> ')
       return nil if res.strip.empty?
@@ -155,6 +160,7 @@ module Journal
     ## @return     [Number] integer response
     ##
     def read_line_gum(prompt)
+      trap('SIGINT') { exit! }
       `gum input --placeholder "#{prompt} (blank to end answer)"`
     end
 
@@ -164,6 +170,7 @@ module Journal
     ## @return     [string] multiline input
     ##
     def read_mutliline_tty
+      trap('SIGINT') { exit! }
       reader = TTY::Reader.new
       res = reader.read_multiline
       res.join("\n")
@@ -175,6 +182,7 @@ module Journal
     ## @return     [string] multiline input
     ##
     def read_multiline_gum(prompt)
+      trap('SIGINT') { exit! }
       `gum write --placeholder "#{prompt}" --width 80 --char-limit 0`
     end
   end

data/lib/journal-cli/section.rb

@@ -2,7 +2,7 @@
 
 module Journal
   class Section
-    attr_accessor :key, :title, :questions, :answers
+    attr_accessor :key, :title, :questions, :answers, :condition
 
     ##
     ## Initializes the given section.
@@ -15,6 +15,7 @@ module Journal
     def initialize(section)
       @key = section['key']
       @title = section['title']
+      @condition = section.key?('condition') ? section['condition'].parse_condition : true
       @questions = section['questions'].map { |question| Question.new(question) }
       @questions.delete_if { |q| q.prompt.nil? }
       @answers = {}
@@ -38,9 +39,9 @@ module Journal
             res = res[key]
           end
 
-          res[keys.last] = question.ask
+          res[keys.last] = question.ask(@condition)
         else
-          @answers[question.key] = question.ask
+          @answers[question.key] = question.ask(@condition)
         end
       end
     end

data/lib/journal-cli/string.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# String helpers
+class ::String
+  def parse_condition
+    condition = dup
+    time_rx = /(?<comp>[<>=]{1,2}|before|after) +(?<time>(?:noon|midnight|[0-9]+) *(?:am|pm)?)$/i
+    return true unless condition =~ time_rx
+
+    now = Journal.date
+    m = condition.match(time_rx)
+    time = Chronic.parse(m['time'])
+    Journal.notify("{br}Invalid time string in question (#{m['time']})", exit_code: 4) unless time
+
+    case m['comp']
+    when /^<=$/
+      now <= time
+    when /^(<|bef)/i
+      now < time
+    when /^>=/
+      now >= time
+    when /^(>|aft)/i
+      now > time
+    end
+    # TODO: Other condition types
+  end
+end

data/lib/journal-cli/version.rb

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

data/lib/journal-cli/weather.rb

@@ -54,6 +54,14 @@ module Journal
       }
     end
 
+    def current
+      "#{@data[:temp]} and #{@data[:current_condition]}"
+    end
+
+    def forecast
+      "#{@data[:condition]} #{@data[:high]}/#{@data[:low]}"
+    end
+
     def to_s
       "#{@data[:temp].round} and #{@data[:current_condition]} (#{@data[:high].round}/#{@data[:low].round})"
     end
@@ -61,8 +69,8 @@ module Journal
     def to_markdown
       output = []
 
-      output << "Forecast for #{@data[:day]}: #{@data[:condition]} #{@data[:high]}/#{@data[:low]}  "
-      output << "Currently: #{@data[:temp]} and #{@data[:current_condition]}"
+      output << "Forecast for #{@data[:day]}: #{forecast}  "
+      output << "Currently: #{current}"
       output << ''
 
       # Hours

data/lib/journal-cli.rb

@@ -11,6 +11,7 @@ require 'tty-which'
 require 'tty-reader'
 require_relative 'journal-cli/version'
 require_relative 'journal-cli/color'
+require_relative 'journal-cli/string'
 require_relative 'journal-cli/data'
 require_relative 'journal-cli/weather'
 require_relative 'journal-cli/checkin'
@@ -21,6 +22,8 @@ require_relative 'journal-cli/question'
 # Main Journal module
 module Journal
   class << self
+    attr_accessor :date
+
     def notify(string, debug: false, exit_code: nil)
       if debug
         $stderr.puts "{dw}#{string}{x}".x

data/src/_README.md

@@ -55,6 +55,10 @@ This file contains a YAML definition of your journal. Each journal gets a top-le
 
 You can include weather data automatically by setting a question type to 'weather'. In order for this to work, you'll need to define `zip` and `weather_api` keys. `zip` is just your zip code, and `weather_api` is a key from WeatherAPI.com. Sign up [here](https://www.weatherapi.com/) for a free plan, and then visit the [profile page](https://www.weatherapi.com/my/) to see your API key at the top.
 
+If a question type is set to `weather.forecast`, only the predicted condition, high, and low will be included in the JSON data for the question. A full printout of hourly temps will be included in the Markdown/Day One output.
+
+If the question type is `weather.current`, only the current condition and temperature will be recorded to the JSON, and a string containing "[TEMP] and [CONDITION]" (e.g. "64 and Sunny") will be recorded to Markdown/Day One for the question.
+
 ### Journal Configuration
 
 Edit the file at `~/.config/journal/journals.yaml` following this structure:
@@ -99,9 +103,12 @@ journals: # required key
       - title: Weather # Title of the section (will create template sections in Day One)
         key: weather # the key to use in the structured data, will contain all of the answers
         questions: # required key
-          - prompt: Current weather # The prompt shown on the command line, will also become a header in the journal entries (Markdown, Day One)
+          - prompt: Current Weather
+            key: weather.current
+            type: weather.current
+          - prompt: Weather Forecast # The prompt shown on the command line, will also become a header in the journal entries (Markdown, Day One)
             key: weather.forecast # if a key contains a dot, it will create nested data, e.g. `{ 'weather': { 'forecast': data } }`
-            type: weather # Set this to weather for weather data
+            type: weather.forecast # Set this to weather for weather data
       - title: Health # New section
         key: health 
         questions:
@@ -144,10 +151,18 @@ A question `type` can be one of:
 - `text` or `string` will request a single-line string, submitted on return
 - `multiline` for multiline strings (opens a readline editor, use ctrl-d to save)
 - `weather` will just insert current weather data with no prompt
+  * `weather.forecast` will insert just the forecast
+  * `weather.current` will insert just the current temperature and condition
 - `number` or `float` will request numeric input, stored as a float (decimal)
 - `integer` will convert numeric input to the nearest integer
 - `date` will request a natural language date which will be parsed into a date object
 
+### Conditional Questions
+
+You can have a question only show up based on conditions. Currently the only condition is time based. Just add a key called `condition` to the question definition, then include a natural language string like `before noon` or `after 3pm`. If the condition is matched, then the question will be displayed, otherwise it will be skipped and its data entry in the JSON will be null.
+
+Conditions can be applied to individual questions, or to entire sections, depending on where the `condition` key is placed.
+
 ### Naming Keys
 
 If you want data stored in a nested object, you can set a question type to `dictionary` and set the prompt to `null` (or just leave the key out), but give it a key that will serve as the parent in the object. Then in the nested questions, give them a key in the dot format `[PARENT_KEY].[CHILD_KEY]`. Section keys automatically nest their questions, but if you want to go deeper, you could have a question with the key `health` and type `dictionary`, then have questions with keys like `health.rating` and `health.notes`. If the section key was `status`, the resulting dictionary would look like this in the JSON:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.22
+  version: 1.0.24
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-which
@@ -238,6 +238,7 @@ files:
 - lib/journal-cli/question.rb
 - lib/journal-cli/section.rb
 - lib/journal-cli/sections.rb
+- lib/journal-cli/string.rb
 - lib/journal-cli/version.rb
 - lib/journal-cli/weather.rb
 - src/_README.md