journal-cli 1.0.16 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3855c36879c6970f3e312add21e3b1d4b8667c69d32d32d59389211a47ce87a
-  data.tar.gz: 8b7fe4a087f81ed075ad41bbfe84df52e250779fae1591719138d90dfbf6e093
+  metadata.gz: 2ebc5eaefc846fb4343859ff0148a7798e93e2a4bcc04c5c73ce18151e59ea94
+  data.tar.gz: 87ca031548e115350383a28da8ec853d6d665dd2a9c88ac3ea32105350120785
 SHA512:
-  metadata.gz: 81f6c91df724bd480d8c67284c23b7d1405f5bffbfb2a5626a03ede1444decd3fa6c77f1c55c8414ad65f7c3c1359f58e7a559d592ae43ac76cca4e1e0794be6
-  data.tar.gz: 756849fb99ee4e287a5e3943b35c3bb1d6b7d1a9cf72d9441b7c849060a80300d310809a8b6ac3e74d9f7b6afbdff4bf968891f020857746ca77773b15e2b09f
+  metadata.gz: 7d15d09cce5d189a2d6168e02e9c3122334a88ea9e011b82fa97b0a732901913b6668407f3474211ef6b40b3b068363d9778ff4471a8ded4366089338f3fd7af
+  data.tar.gz: 3bce2d14e6d5f078b481b9d38184e9cd005c336aeecb36bf4a5daa8b7ef66510c60d46d3cd9db97e254266c8c91a07bbf209785b3aedd2d27f6a255e256f0341

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+### 1.0.18
+
+2023-09-09 12:29
+
+#### IMPROVED
+
+- Include the answers to all questions as YAML front matter when writing individual Markdown files. This allows for tools like [obsidian-dataview](https://github.com/blacksmithgu/obsidian-dataview) to be used as parsers
+
+#### FIXED
+
+- Daily markdown was being saved to /journal/entries/KEY/entries
+- Missing color library
+
+### 1.0.17
+
+2023-09-08 07:21
+
+#### IMPROVED
+
+- More confirmation messages when saving
+
 ### 1.0.16
 
 2023-09-07 11:12

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    journal-cli (1.0.16)
+    journal-cli (1.0.18)
       chronic (~> 0.10, >= 0.10.2)
 
 GEM

data/README.md

@@ -48,7 +48,7 @@ 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.
 
-### Journal configuration
+### Journal Configuration
 
 Edit the file at `~/.config/journal/journals.yaml` following this structure:
 
@@ -128,6 +128,28 @@ journals: # required key
 
 A journal must contain a `sections` key, and each section must contain a `questions` key with an array of questions. Each question must (at minimum) have a `prompt`, `key`, and `type`.
 
+If a question has a key `secondary_question`, the prompt will be repeated with the secondary question until it's returned empty, answers will be joined together.
+
+### 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 children, 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:
+
+```json
+{
+  "date": "2023-09-08 12:19:40 UTC",
+  "data": {
+    "status": {
+      "health": {
+        "rating": 4,
+        "notes": "Feeling much better today. Still a bit groggy."
+      }
+    }
+  }
+}
+```
+
+If a question has the same key as its parent section, it will be moved up the chain so that you don't get `{ 'journal': { 'journal': 'Journal notes' } }`. You'll just get `{ 'journal': 'Journal notes' }`. This offers a way to organize data with fewer levels of nesting in the output.
+
 ## Usage
 
 Once your configuration file is set up, you can just run `journal JOURNAL_KEY` to begin prompting for the answers to the configured questions. 

data/bin/journal

@@ -58,6 +58,11 @@ optparse = OptionParser.new do |opts|
     Process.exit 0
   end
 
+  Color.coloring = $stdout.isatty
+  opts.on('--[no-]color', 'Colorize output') do |c|
+    Color.coloring = c
+  end
+
   opts.on('-h', '--help', 'Display help') do
     puts opts
     puts

data/lib/journal-cli/checkin.rb

@@ -63,15 +63,16 @@ module Journal
       cmd << %(-t #{@journal['tags'].join(' ')}) if @journal.key?('tags')
       cmd << %(-date "#{@date.strftime('%Y-%m-%d %I:%M %p')}")
       `echo #{Shellwords.escape(to_markdown(yaml: false, title: true))} | #{cmd.join(' ')} -- new`
+      Journal.notify('{bg}Entered one entry into Day One')
     end
 
     def save_single_markdown
       dir = if @journal.key?('entries_folder')
               File.join(File.expand_path(@journal['entries_folder']), 'entries')
             elsif Journal.config.key?('entries_folder')
-              File.join(File.expand_path(Journal.config['entries_folder']), @key, 'entries')
+              File.join(File.expand_path(Journal.config['entries_folder']), @key)
             else
-              File.expand_path('~/.local/share/journal', @key, 'entries')
+              File.expand_path("~/.local/share/journal/#{@key}/entries")
             end
 
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
@@ -84,16 +85,16 @@ module Journal
         f.puts
         f.puts to_markdown(yaml: false, title: false)
       end
-      puts "Saved #{target}"
+      Journal.notify "{bg}Added new entry to {bw}#{target}"
     end
 
     def save_daily_markdown
       dir = if @journal.key?('entries_folder')
               File.join(File.expand_path(@journal['entries_folder']), 'entries')
             elsif Journal.config.key?('entries_folder')
-              File.join(File.expand_path(Journal.config['entries_folder']), @key, 'entries')
+              File.join(File.expand_path(Journal.config['entries_folder']), @key)
             else
-              File.join(File.expand_path('~/.local/share/journal/entries'), @key, 'entries')
+              File.join(File.expand_path("~/.local/share/journal/#{@key}/entries"))
             end
 
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
@@ -105,7 +106,7 @@ module Journal
       else
         File.open(target, 'w') { |f| f.puts to_markdown(yaml: true, title: true, date: false, time: true) }
       end
-      puts "Saved #{target}"
+      Journal.notify "{bg}Saved daily Markdown to {bw}#{target}"
     end
 
     def save_individual_markdown
@@ -123,7 +124,7 @@ module Journal
       filename = @date.strftime('%Y-%m-%d_%H:%M.md')
       target = File.join(dir, filename)
       File.open(target, 'w') { |f| f.puts to_markdown(yaml: true, title: true) }
-      puts "Saved #{target}"
+      puts "Saved new entry to #{target}"
     end
 
     def print_answer(prompt, type, key, data)
@@ -143,18 +144,33 @@ module Journal
       end
     end
 
+    def weather_to_yaml(answers)
+      data = {}
+      answers.each do |k, v|
+        case v.class.to_s
+        when /Hash/
+          data[k] = weather_to_yaml(v)
+        when /Weather/
+          data[k] = v.to_s
+        else
+          data[k] = v
+        end
+      end
+      data
+    end
+
     def to_markdown(yaml: false, title: false, date: false, time: false)
       @output = []
 
       if yaml
         @date.localtime
-        @output << <<~EOYAML
-          ---
-          title: #{@title}
-          date: #{@date.strftime('%x %X')}
-          ---
+        yaml_data = { 'title' => @title, 'date' => @date.strftime('%x %X')}
+        @data.each do |key, data|
+          yaml_data = yaml_data.merge(weather_to_yaml(data.answers))
+        end
 
-        EOYAML
+        @output << YAML.dump(yaml_data).strip
+        @output << '---'
       end
 
       if title
@@ -198,7 +214,7 @@ module Journal
             elsif Journal.config.key?('entries_folder')
               File.expand_path(Journal.config['entries_folder'])
             else
-              File.expand_path("~/.local/share/journal")
+              File.expand_path('~/.local/share/journal')
             end
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
       db = File.join(dir, "#{@key}.json")
@@ -217,13 +233,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] }
+                         {
+                           'high' => value.data[:high],
+                           'low' => value.data[:low],
+                           'condition' => value.data[:condition]
+                         }
                        else
                          value
                        end
               if jk == k
                 output[jk][key] = result
               else
+                output[jk][k] ||= {}
                 output[jk][k][key] = result
               end
             end
@@ -245,6 +266,7 @@ module Journal
       data.sort_by! { |e| e['date'] }
 
       File.open(db, 'w') { |f| f.puts JSON.pretty_generate(data) }
+      Journal.notify "{bg}Saved {bw}#{db}"
     end
   end
 end

data/lib/journal-cli/color.rb

@@ -0,0 +1,363 @@
+# frozen_string_literal: true
+
+# Cribbed from <https://github.com/flori/term-ansicolor>
+# Terminal output color functions.
+module Color
+  # Regexp to match excape sequences
+  ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/
+
+  # All available color names. Available as methods and string extensions.
+  #
+  # @example Use a color as a method. Color reset will be added to end of string.
+  #   Color.yellow('This text is yellow') => "\e[33mThis text is yellow\e[0m"
+  #
+  # @example Use a color as a string extension. Color reset added automatically.
+  #   'This text is green'.green => "\e[1;32mThis text is green\e[0m"
+  #
+  # @example Send a text string as a color
+  #   Color.send('red') => "\e[31m"
+  ATTRIBUTES = [
+    [:clear,               0], # String#clear is already used to empty string in Ruby 1.9
+    [:reset,               0], # synonym for :clear
+    [:bold,                1],
+    [:dark,                2],
+    [:italic,              3], # not widely implemented
+    [:underline,           4],
+    [:underscore,          4], # synonym for :underline
+    [:blink,               5],
+    [:rapid_blink,         6], # not widely implemented
+    [:negative,            7], # no reverse because of String#reverse
+    [:concealed,           8],
+    [:strikethrough,       9], # not widely implemented
+    [:strike,              9], # not widely implemented
+    [:black,              30],
+    [:red,                31],
+    [:green,              32],
+    [:yellow,             33],
+    [:blue,               34],
+    [:magenta,            35],
+    [:purple,             35],
+    [:cyan,               36],
+    [:white,              37],
+    [:bgblack,            40],
+    [:bgred,              41],
+    [:bggreen,            42],
+    [:bgyellow,           43],
+    [:bgblue,             44],
+    [:bgmagenta,          45],
+    [:bgpurple,           45],
+    [:bgcyan,             46],
+    [:bgwhite,            47],
+    [:boldblack,          90],
+    [:boldred,            91],
+    [:boldgreen,          92],
+    [:boldyellow,         93],
+    [:boldblue,           94],
+    [:boldmagenta,        95],
+    [:boldpurple,         95],
+    [:boldcyan,           96],
+    [:boldwhite,          97],
+    [:boldbgblack,       100],
+    [:boldbgred,         101],
+    [:boldbggreen,       102],
+    [:boldbgyellow,      103],
+    [:boldbgblue,        104],
+    [:boldbgmagenta,     105],
+    [:boldbgpurple,      105],
+    [:boldbgcyan,        106],
+    [:boldbgwhite,       107],
+    [:softpurple,  '0;35;40'],
+    [:hotpants,    '7;34;40'],
+    [:knightrider, '7;30;40'],
+    [:flamingo,    '7;31;47'],
+    [:yeller,      '1;37;43'],
+    [:whiteboard,  '1;30;47'],
+    [:chalkboard,  '1;37;40'],
+    [:led,         '0;32;40'],
+    [:redacted,    '0;30;40'],
+    [:alert,       '1;31;43'],
+    [:error,       '1;37;41'],
+    [:default, '0;39']
+  ].map(&:freeze).freeze
+
+  # Array of attribute keys only
+  ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
+
+  # Returns true if Color supports the +feature+.
+  #
+  # The feature :clear, that is mixing the clear color attribute into String,
+  # is only supported on ruby implementations, that do *not* already
+  # implement the String#clear method. It's better to use the reset color
+  # attribute instead.
+  def support?(feature)
+    case feature
+    when :clear
+      !String.instance_methods(false).map(&:to_sym).include?(:clear)
+    end
+  end
+
+  # Template coloring
+  class ::String
+    ##
+    ## Extract the longest valid %color name from a string.
+    ##
+    ## Allows %colors to bleed into other text and still
+    ## be recognized, e.g. %greensomething still finds
+    ## %green.
+    ##
+    ## @return     [String] a valid color name
+    ##
+    def validate_color
+      valid_color = nil
+      compiled = ''
+      normalize_color.split('').each do |char|
+        compiled += char
+        valid_color = compiled if Color.attributes.include?(compiled.to_sym) || compiled =~ /^([fb]g?)?#([a-f0-9]{6})$/i
+      end
+
+      valid_color
+    end
+
+    ##
+    ## Normalize a color name, removing underscores,
+    ## replacing "bright" with "bold", and converting
+    ## bgbold to boldbg
+    ##
+    ## @return     [String] Normalized color name
+    ##
+    def normalize_color
+      gsub(/_/, '').sub(/bright/i, 'bold').sub(/bgbold/, 'boldbg')
+    end
+
+    # Get the calculated ANSI color at the end of the
+    # string
+    #
+    # @return     ANSI escape sequence to match color
+    #
+    def last_color_code
+      m = scan(ESCAPE_REGEX)
+
+      em = ['0']
+      fg = nil
+      bg = nil
+      rgbf = nil
+      rgbb = nil
+
+      m.each do |c|
+        case c
+        when '0'
+          em = ['0']
+          fg, bg, rgbf, rgbb = nil
+        when /^[34]8/
+          case c
+          when /^3/
+            fg = nil
+            rgbf = c
+          when /^4/
+            bg = nil
+            rgbb = c
+          end
+        else
+          c.split(/;/).each do |i|
+            x = i.to_i
+            if x <= 9
+              em << x
+            elsif x >= 30 && x <= 39
+              rgbf = nil
+              fg = x
+            elsif x >= 40 && x <= 49
+              rgbb = nil
+              bg = x
+            elsif x >= 90 && x <= 97
+              rgbf = nil
+              fg = x
+            elsif x >= 100 && x <= 107
+              rgbb = nil
+              bg = x
+            end
+          end
+        end
+      end
+
+      escape = "\e[#{em.join(';')}m"
+      escape += "\e[#{rgbb}m" if rgbb
+      escape += "\e[#{rgbf}m" if rgbf
+      escape + "\e[#{[fg, bg].delete_if(&:nil?).join(';')}m"
+    end
+  end
+
+  class << self
+    # Returns true if the coloring function of this module
+    # is switched on, false otherwise.
+    def coloring?
+      @coloring
+    end
+
+    attr_writer :coloring
+
+    ##
+    ## Enables colored output
+    ##
+    ## @example Turn color on or off based on TTY
+    ##   Color.coloring = STDOUT.isatty
+    def coloring
+      @coloring ||= true
+    end
+
+    ##
+    ## Convert a template string to a colored string.
+    ## Colors are specified with single letters inside
+    ## curly braces. Uppercase changes background color.
+    ##
+    ## w: white, k: black, g: green, l: blue, y: yellow, c: cyan,
+    ## m: magenta, r: red, b: bold, u: underline, i: italic,
+    ## x: reset (remove background, color, emphasis)
+    ##
+    ## Also accepts {#RGB} and {#RRGGBB} strings. Put a b before
+    ## the hash to make it a background color
+    ##
+    ## @example Convert a templated string
+    ##   Color.template('{Rwb}Warning:{x} {w}you look a little {g}ill{x}')
+    ##
+    ## @example Convert using RGB colors
+    ##   Color.template('{#f0a}This is an RGB color')
+    ##
+    ## @param      input  [String, Array] The template
+    ##                    string. If this is an array, the
+    ##                    elements will be joined with a
+    ##                    space.
+    ##
+    ## @return     [String] Colorized string
+    ##
+    def template(input)
+      input = input.join(' ') if input.is_a? Array
+      return input.gsub(/(?<!\\)\{(\w+)\}/i, '') unless Color.coloring?
+
+      input = input.gsub(/(?<!\\)\{((?:[fb]g?)?#[a-f0-9]{3,6})\}/i) do
+                hex = Regexp.last_match(1)
+                rgb(hex)
+              end
+
+      fmt = input.gsub(/%/, '%%')
+      fmt = fmt.gsub(/(?<!\\)\{(\w+)\}/i) do
+        Regexp.last_match(1).split('').map { |c| "%<#{c}>s" }.join('')
+      end
+
+      colors = { w: white, k: black, g: green, l: blue,
+                 y: yellow, c: cyan, m: magenta, r: red,
+                 W: bgwhite, K: bgblack, G: bggreen, L: bgblue,
+                 Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
+                 d: dark, b: bold, u: underline, i: italic, x: reset }
+
+      format(fmt, colors)
+    end
+  end
+
+  ATTRIBUTES.each do |c, v|
+    new_method = <<-EOSCRIPT
+      # Color string as #{c}
+      def #{c}(string = nil)
+        result = ''
+        result << "\e[#{v}m" if Color.coloring?
+        if block_given?
+          result << yield
+        elsif string.respond_to?(:to_str)
+          result << string.to_str
+        elsif respond_to?(:to_str)
+          result << to_str
+        else
+          return result #only switch on
+        end
+        result << "\e[0m" if Color.coloring?
+        result
+      end
+    EOSCRIPT
+
+    module_eval(new_method)
+
+    next unless c =~ /bold/
+
+    # Accept brightwhite in addition to boldwhite
+    new_method = <<-EOSCRIPT
+      # color string as #{c}
+      def #{c.to_s.sub(/bold/, 'bright')}(string = nil)
+        result = ''
+        result << "\e[#{v}m" if Color.coloring?
+        if block_given?
+          result << yield
+        elsif string.respond_to?(:to_str)
+          result << string.to_str
+        elsif respond_to?(:to_str)
+          result << to_str
+        else
+          return result #only switch on
+        end
+        result << "\e[0m" if Color.coloring?
+        result
+      end
+    EOSCRIPT
+
+    module_eval(new_method)
+  end
+
+  ##
+  ## Generate escape codes for hex colors
+  ##
+  ## @param      hex   [String] The hexadecimal color code
+  ##
+  ## @return     [String] ANSI escape string
+  ##
+  def rgb(hex)
+    is_bg = hex.match(/^bg?#/) ? true : false
+    hex_string = hex.sub(/^([fb]g?)?#/, '')
+
+    if hex_string.length == 3
+      parts = hex_string.match(/(?<r>.)(?<g>.)(?<b>.)/)
+
+      t = []
+      %w[r g b].each do |e|
+        t << parts[e]
+        t << parts[e]
+      end
+      hex_string = t.join('')
+    end
+
+    parts = hex_string.match(/(?<r>..)(?<g>..)(?<b>..)/)
+    t = []
+    %w[r g b].each do |e|
+      t << parts[e].hex
+    end
+
+    "\e[#{is_bg ? '48' : '38'};2;#{t.join(';')}m"
+  end
+
+  # Regular expression that is used to scan for ANSI-sequences while
+  # uncoloring strings.
+  COLORED_REGEXP = /\e\[(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+m/
+
+  # Returns an uncolored version of the string, that is all
+  # ANSI-sequences are stripped from the string.
+  def uncolor(string = nil) # :yields:
+    if block_given?
+      yield.to_str.gsub(COLORED_REGEXP, '')
+    elsif string.respond_to?(:to_str)
+      string.to_str.gsub(COLORED_REGEXP, '')
+    elsif respond_to?(:to_str)
+      to_str.gsub(COLORED_REGEXP, '')
+    else
+      ''
+    end
+  end
+
+  # Returns an array of all Color attributes as symbols.
+  def attributes
+    ATTRIBUTE_NAMES
+  end
+  extend self
+end
+
+class ::String
+  def x
+    Color.template(self)
+  end
+end

data/lib/journal-cli/question.rb

@@ -17,7 +17,7 @@ module Journal
       @type = question['type']
       @min = question['min']&.to_i || 1
       @max = question['max']&.to_i || 5
-      @prompt = question['prompt']
+      @prompt = question['prompt'] || nil
       @secondary_prompt = question['secondary_prompt'] || nil
     end
 
@@ -27,6 +27,8 @@ module Journal
     ## @return     [Number, String] the response based on @type
     ##
     def ask
+      return nil if @prompt.nil?
+
       case @type
       when /^(int|num)/i
         read_number
@@ -36,16 +38,20 @@ module Journal
         Weather.new(Journal.config['weather_api'], Journal.config['zip'])
       when /^multi/
         read_lines
+      when /^date/
+        read_date
       end
     end
 
+    private
+
     ##
     ## Read a numeric entry
     ##
     ## @return     [Number] integer response
     ##
     def read_number
-      puts "#{@prompt} (#{@min}-#{@max})"
+      Journal.notify("{by}#{@prompt} {c}({bw}#{@min}{c}-{bw}#{@max})")
       res = `gum input --placeholder "#{@prompt} (#{@min}-#{@max})"`.strip
       return nil if res.strip.empty?
 
@@ -55,6 +61,12 @@ module Journal
       res
     end
 
+    def read_date(prompt: nil)
+      Journal.notify("{by}#{prompt.nil? ? @prompt : prompt} (natural language)")
+      line = `gum input --placeholder "#{@prompt} (blank to end editing)"`
+      Chronic.parse(line)
+    end
+
     ##
     ## Reads a line.
     ##
@@ -66,7 +78,7 @@ module Journal
     ##
     def read_line(prompt: nil)
       output = []
-      puts prompt.nil? ? @prompt : @secondary_prompt
+      Journal.notify("{by}#{prompt.nil? ? @prompt : @secondary_prompt}")
 
       line = `gum input --placeholder "#{@prompt} (blank to end editing)"`
       return output.join("\n") if line =~ /^ *$/
@@ -87,7 +99,7 @@ module Journal
     ##
     def read_lines(prompt: nil)
       output = []
-      puts (prompt.nil? ? @prompt : @secondary_prompt) + ' (CTRL-d to save)'
+      Journal.notify("{by}#{prompt.nil? ? @prompt : @secondary_prompt} {c}({bw}CTRL-d{c} to save)'")
       line = `gum write --placeholder "#{prompt}" --width 80 --char-limit 0`
       return output.join("\n") if line.strip.empty?
 

data/lib/journal-cli/section.rb

@@ -16,6 +16,7 @@ module Journal
       @key = section['key']
       @title = section['title']
       @questions = section['questions'].map { |question| Question.new(question) }
+      @questions.delete_if { |q| q.prompt.nil? }
       @answers = {}
       ask_questions
     end

data/lib/journal-cli/version.rb

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

data/lib/journal-cli/weather.rb

@@ -54,6 +54,10 @@ module Journal
       }
     end
 
+    def to_s
+      "#{@data[:temp].round} and #{@data[:current_condition]} (#{@data[:high].round}/#{@data[:low].round})"
+    end
+
     def to_markdown
       output = []
 

data/lib/journal-cli.rb

@@ -8,6 +8,7 @@ require 'chronic'
 require 'fileutils'
 
 require_relative 'journal-cli/version'
+require_relative 'journal-cli/color'
 require_relative 'journal-cli/data'
 require_relative 'journal-cli/weather'
 require_relative 'journal-cli/checkin'
@@ -18,6 +19,16 @@ require_relative 'journal-cli/question'
 # Main Journal module
 module Journal
   class << self
+    def notify(string, debug: false, exit_code: nil)
+      if debug
+        $stderr.puts "{dw}#{string}{x}".x
+      else
+        $stderr.puts "#{string}{x}".x
+      end
+
+      Process.exit exit_code unless exit_code.nil?
+    end
+
     def config
       unless @config
         config = File.expand_path('~/.config/journal/journals.yaml')
@@ -49,8 +60,7 @@ module Journal
         @config = YAML.load(IO.read(config))
 
         if @config['journals'].key?('demo')
-          puts "Demo journal detected, please edit the configuration file at #{config}"
-          Process.exit 1
+          Journal.notify("{br}Demo journal detected, please edit the configuration file at {bw}#{config}", exit_code: 1)
         end
       end
 

data/src/_README.md

@@ -51,7 +51,7 @@ 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.
 
-### Journal configuration
+### Journal Configuration
 
 Edit the file at `~/.config/journal/journals.yaml` following this structure:
 
@@ -131,6 +131,28 @@ journals: # required key
 
 A journal must contain a `sections` key, and each section must contain a `questions` key with an array of questions. Each question must (at minimum) have a `prompt`, `key`, and `type`.
 
+If a question has a key `secondary_question`, the prompt will be repeated with the secondary question until it's returned empty, answers will be joined together.
+
+### 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 children, 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:
+
+```json
+{
+  "date": "2023-09-08 12:19:40 UTC",
+  "data": {
+    "status": {
+      "health": {
+        "rating": 4,
+        "notes": "Feeling much better today. Still a bit groggy."
+      }
+    }
+  }
+}
+```
+
+If a question has the same key as its parent section, it will be moved up the chain so that you don't get `{ 'journal': { 'journal': 'Journal notes' } }`. You'll just get `{ 'journal': 'Journal notes' }`. This offers a way to organize data with fewer levels of nesting in the output.
+
 ## Usage
 
 Once your configuration file is set up, you can just run `journal JOURNAL_KEY` to begin prompting for the answers to the configured questions. 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.0.18
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2023-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,7 @@ files:
 - journal-cli.gemspec
 - lib/journal-cli.rb
 - lib/journal-cli/checkin.rb
+- lib/journal-cli/color.rb
 - lib/journal-cli/data.rb
 - lib/journal-cli/question.rb
 - lib/journal-cli/section.rb