journal-cli 1.0.5 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c6fdd6421db40eaa592ff8fee665dc350314988633ac566abf2e758439d3906
-  data.tar.gz: e3ab8c9d573c34ef3544261d69bbe07e225005e7451cf5c99332f77a04901d05
+  metadata.gz: daaf3cad805bf34bae2691d8d5738316aef4318bf9f6a9562fcbc38c27f0e3be
+  data.tar.gz: 861bca0aae3312d48dd070dc5c88cffadb709242e9374f25856ac6b5b5189cfd
 SHA512:
-  metadata.gz: 797789942a88387b3d3c6151f8778c6762e32a3e1feac7045a7be86aff3388241b2ce71fd260843b5ddc8323969c2b770d306286313935f12493a71b55e7feb7
-  data.tar.gz: a24535361f2225a6f21ea4abbb23b8e1b0c38aa733e6447de34883d529381f5b69c223373ef4057e8a0f64b5181fb0dceb0c973f7bab5efd25dd2ce1c6ecd0e1
+  metadata.gz: 0c982533e8d04247ccfffe560549f01ea57725bfcc0391294ece7bb32adf56fdee95589700fcdb6ca855dddaa446dfe06c6d15a394befd231683680194678670
+  data.tar.gz: 787c597423d1ef820068b6498fd5004edf17e19c2e6f723e69b6feca919c8cc8bbe9127304749ce3c88b320d69e330823f51e0de14f7c1995e0c2d1a98fdc690

data/CHANGELOG.md

@@ -1,43 +1,28 @@
-### 1.0.5
+### 1.0.10
 
-2023-09-06 09:24
+2023-09-06 16:03
 
-### 1.0.4
+#### IMPROVED
 
-2023-09-06 09:23
+- Refactoring code
 
-#### NEW
+### 1.0.9
 
-- Initial journal command
-- Multiple journals, multiple sections
-
-### 1.0.3
-
-2023-09-06 09:10
+2023-09-06 11:58
 
 #### NEW
 
-- Initial journal command
-- Multiple journals, multiple sections
-
-### 1.0.2
+- If the second argument is a natural language date, use the parsed result instead of the current time for the entry
 
-2023-09-06 09:09
-
-#### NEW
+### 1.0.5
 
-- Initial journal command
-- Multiple journals, multiple sections
+2023-09-06 09:24
 
-### 1.0.1
+### 1.0.0
 
-2023-09-06 09:07
+2023-09-06 09:23
 
 #### NEW
 
 - Initial journal command
 - Multiple journals, multiple sections
-
-### 1.0.0
-
-2023-09-05 16:46

data/Gemfile.lock

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

data/README.md

@@ -49,18 +49,19 @@ You can include weather data automatically by setting a question type to 'weathe
 Edit the file at `~/.config/journal/journals.yaml` following this structure:
 
 ```yaml
-daily: # journal key, will be used on the command line as `journal daily`
-  dayone: true # Enable or disable Day One integration
-  journal: Journal # Day One journal to add to (if using Day One integration)
-  markdown: daily # Type of Markdown file to create, false to skip (can be daily, individual, or digest)
-  title: Daily Journal # Title for every entry, date will be appended where needed
-  sections: # Required key
-    - title: null # The title for the section. If null, no section header will be created
-      key: journal # The key for the data collected, must be one word, alphanumeric characters and _ only
-      questions: # Required key
-        - prompt: How are you feeling? # The question to ask
-          key: journal # alphanumeric characters and _ only, will be nested in section key
-          type: multiline # The type of entry expected (numeric, string, or multiline)
+journals:
+  daily: # journal key, will be used on the command line as `journal daily`
+    dayone: true # Enable or disable Day One integration
+    journal: Journal # Day One journal to add to (if using Day One integration)
+    markdown: daily # Type of Markdown file to create, false to skip (can be daily, individual, or digest)
+    title: Daily Journal # Title for every entry, date will be appended where needed
+    sections: # Required key
+      - title: null # The title for the section. If null, no section header will be created
+        key: journal # The key for the data collected, must be one word, alphanumeric characters and _ only
+        questions: # Required key
+          - prompt: How are you feeling? # The question to ask
+            key: journal # alphanumeric characters and _ only, will be nested in section key
+            type: multiline # The type of entry expected (numeric, string, or multiline)
 ```
 
 Keys must be alphanumeric characters and `_` (underscore) only. Titles and questions can be anything, but if they contain a colon (:), you'll need to quote the string.
@@ -121,7 +122,17 @@ A journal must contain a `sections` key, and each section must contain a `questi
 
 Once your configuration file is set up, you can just run `journal JOURNAL_KEY` to begin prompting for the answers to the configured questions. 
 
+If a second argument contains a natural language date, the journal entry will be set to that date instead of the current time. For example, `journal mood "yesterday 5pm"` will create a new entry (in the journal configured for `mood`) for yesterday at 5pm.
+
 Answers will always be written to `~/.local/share/journal/[KEY].json` (where [KEY] is the journal key, one data file for each journal). If you've specified `daily` or `individual` Markdown formats, entries will be written to Markdown files in `~/.local/share/journal/entries/[KEY]`, either in a `%Y-%m-%d.md` file (daily), or in timestamped individual files. If `digest` is specified for the `markdown` key, a single file will be created at `~/.local/share/journal/[KEY].md`.
 
 At present there's no tool for querying the dataset created. You just need to parse the JSON and use your language of choice to extract the data. Numeric entries are stored as numbers, and every entry is timestamped, so you should be able to do some advanced analysis once you have enough data.
 
+### Answering prompts
+
+Questions with numeric answers will have a valid range assigned. Enter just a number within the range and hit return.
+
+Questions with type 'string' or 'text' will save when you hit return. Pressing return without typing anything will leave that answer blank, and it will be ignored when exporting to Markdown or Day One (an empty value will exist in the JSON database).
+
+When using the mutiline type, you'll get an edit field that responds to most control-key navigation and allows insertion and movement. To save a multiline field, press Escape or type CTRL-d.
+

data/bin/journal

@@ -3,30 +3,52 @@
 $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
 require 'journal-cli'
 
-raise ArgumentError, 'no journal specified' if ARGV.count.zero?
-
-case ARGV[0]
-when /(-v|--version)/
-  puts "journal v#{Journal::VERSION}"
-  Process.exit 0
-when /(help|-h|--help)/
-  puts "journal v#{Journal::VERSION}"
-  puts
-  puts 'Usage: journal [type] [date]'
-  puts
-  puts 'Available journal types:'
-  config = Journal::Checkin.new
-  puts(config.config['journals'].keys.map { |k| "- #{k}" })
-  Process.exit 0
-end
+module Journal
+  class << self
+    def usage
+      puts "journal v#{Journal::VERSION}"
+      puts
+      puts 'Usage: journal [type] [date]'
+      puts
+      puts 'Available journal types:'
+      config = Journal.config
+      puts(config['journals'].keys.map { |k| "- #{k}" })
+    end
+
+    def run(args)
+      if args.count.zero?
+        puts "No journal specified"
+        usage
+        Process.exit 1
+      end
+
+      case args[0]
+      when /(-v|--version)/
+        puts "journal v#{Journal::VERSION}"
+        Process.exit 0
+      when /(help|-h|--help)/
+        usage
+        Process.exit 0
+      end
 
-journal = ARGV.shift
+      journal = args.shift
+
+      date = if args.length.positive?
+               Chronic.parse(args.join(' '), future: false)
+             else
+               Time.now
+             end
+
+      if Journal.config['journals'].key?(journal)
+        checkin = Journal::Checkin.new(journal, date)
+        checkin.go
+      else
+        puts "Journal #{journal} not found"
+        usage
+        Process.exit 1
+      end
+    end
+  end
+end
 
-date = if ARGV.length.positive?
-         Chronic.parse(ARGV.join(' '), future: false)
-       else
-         Time.now
-       end
-checkin = Journal::Checkin.new
-checkin.start(journal, date)
-checkin.go
+Journal.run(ARGV)

data/lib/journal-cli/checkin.rb

@@ -1,23 +1,18 @@
 module Journal
   # Main class
   class Checkin
-    attr_reader :key, :date, :data, :config, :journal, :title, :output
+    attr_reader :key, :date, :data, :config, :journal, :sections, :title, :output
 
-    def initialize
-      config = File.expand_path('~/.config/journal/journals.yaml')
-      raise StandardError, 'No journals configured' unless File.exist?(config)
-
-      @config = YAML.load(IO.read(config))
-    end
-
-    def start(journal, date)
+    def initialize(journal, date)
       @key = journal
       @output = []
       @date = date
+      @date.localtime
 
-      raise StandardError, "No journal with key #{@key} found" unless @config['journals'].key? @key
+      raise StandardError, "No journal with key #{@key} found" unless Journal.config['journals'].key? @key
 
-      @journal = @config['journals'][@key]
+      @journal = Journal.config['journals'][@key]
+      @sections = Sections.new(@journal['sections'])
 
       @data = {}
       meridian = @date.hour < 13 ? 'AM' : 'PM'
@@ -44,93 +39,69 @@ module Journal
       @output << "\n---\n"
     end
 
-    def ask_question(q)
-      res = case q['type']
-            when /^(int|num)/i
-              min = q['min'] || 1
-              max = q['max'] || 5
-              get_number(q['prompt'], min: min, max: max)
-            when /^(text|string|line)/i
-              puts q['prompt']
-              add_prompt = q['secondary_prompt'] || nil
-              get_line(q['prompt'], add_prompt: add_prompt)
-            when /^(weather|forecast)/i
-              Weather.new(@config['weather_api'], @config['zip'])
-            when /^multi/
-              puts q['prompt']
-              add_prompt = q['secondary_prompt'] || nil
-              get_lines(q['prompt'], add_prompt: add_prompt)
-            end
-
-      res
-    end
-
     def go
-      results = Data.new(@journal['questions'])
-      @journal['sections'].each do |s|
-        results[s['key']] = {
-          title: s['title'],
-          answers: {}
-        }
+      @sections.each { |key, section| @data[key] = section }
 
-        s['questions'].each do |q|
-          if q['key'] =~ /\./
-            res = results[s['key']][:answers]
-            keys = q['key'].split(/\./)
-            keys.each_with_index do |key, i|
-              next if i == keys.count - 1
+      save_data
+      save_day_one_entry if @journal['dayone']
 
-              res[key] = {} unless res.key?(key)
-              res = res[key]
-            end
+      return unless @journal['markdown']
 
-            res[keys.last] = ask_question(q)
-          else
-            results[s['key']][:answers][q['key']] = ask_question(q)
-          end
-        end
+      case @journal['markdown']
+      when /^da(y|ily)/
+        save_daily_markdown
+      when /^(ind|sep)/
+        save_individual_markdown
+      else
+        save_single_markdown
       end
+    end
 
-      @data = results
+    def save_day_one_entry
+      cmd = ['dayone2']
+      cmd << %(-j "#{@journal['journal']}") if @journal.key?('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`
+    end
 
-      if @journal['dayone']
-        cmd = ['dayone2']
-        cmd << %(-j "#{@journal['journal']}") if @journal.key?('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)} | #{cmd.join(' ')} -- new`
+    def save_single_markdown
+      dir = File.expand_path('~/.local/share/journal/entries/')
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      filename = "#{@key}.md"
+      @date.localtime
+      target = File.join(dir, filename)
+      File.open(target, 'a') do |f|
+        f.puts
+        f.puts "## #{@title} #{@date.strftime('%x %X')}"
+        f.puts
+        f.puts to_markdown(yaml: false, title: false)
       end
+      puts "Saved #{target}"
+    end
 
-      if @journal['markdown']
-        if @journal['markdown'] =~ /^da(y|ily)/
-          dir = File.expand_path("~/.local/share/journal/entries/#{@key}")
-          FileUtils.mkdir_p(dir) unless File.directory?(dir)
-          filename = "#{@date.strftime('%Y-%m-%d')}.md"
-          target = File.join(dir, filename)
-          if File.exist? target
-            File.open(target, 'a') { |f| f.puts to_markdown(yaml: false, title: true, date: false, time: true) }
-          else
-            File.open(target, 'w') { |f| f.puts to_markdown(yaml: true, title: true, date: false, time: true) }
-          end
-        elsif @journal['markdown'] =~ /^(ind|separate)/
-          dir = File.expand_path("~/.local/share/journal/entries/#{@key}")
-          FileUtils.mkdir_p(dir) unless File.directory?(dir)
-          filename = @date.strftime('%Y-%m-%d_%H:%M.md')
-          File.open(File.join(dir, filename), 'w') { |f| f.puts to_markdown(yaml: true, title: true) }
-        else
-          dir = File.expand_path('~/.local/share/journal/entries/')
-          FileUtils.mkdir_p(dir) unless File.directory?(dir)
-          filename = "#{@key}.md"
-          File.open(File.join(dir, filename), 'a') do |f|
-            f.puts
-            f.puts "## #{@title} #{@date.strftime('%x %X')}"
-            f.puts
-            f.puts to_markdown(yaml: false, title: false)
-          end
-        end
+    def save_daily_markdown
+      dir = File.expand_path("~/.local/share/journal/entries/#{@key}")
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      @date.localtime
+      filename = "#{@date.strftime('%Y-%m-%d')}.md"
+      target = File.join(dir, filename)
+      if File.exist? target
+        File.open(target, 'a') { |f| f.puts to_markdown(yaml: false, title: true, date: false, time: true) }
+      else
+        File.open(target, 'w') { |f| f.puts to_markdown(yaml: true, title: true, date: false, time: true) }
       end
+      puts "Saved #{target}"
+    end
 
-      save_data
+    def save_individual_markdown
+      dir = File.expand_path("~/.local/share/journal/entries/#{@key}")
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      @date.localtime
+      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}"
     end
 
     def print_answer(prompt, type, key, data)
@@ -154,6 +125,7 @@ module Journal
       @output = []
 
       if yaml
+        @date.localtime
         @output << <<~EOYAML
           ---
           title: #{@title}
@@ -174,21 +146,22 @@ module Journal
         end
       end
 
-      @journal['sections'].each do |s|
-        section s['title']
+      @sections.each do |key, section|
+        answers = section.answers
+        section section.title
 
-        s['questions'].each do |q|
-          if q['key'] =~ /\./
-            res = @data[s['key']][:answers].dup
-            keys = q['key'].split(/\./)
+        section.questions.each do |question|
+          if question.key =~ /\./
+            res = section.answers.dup
+            keys = question.key.split(/\./)
             keys.each_with_index do |key, i|
               next if i == keys.count - 1
 
               res = res[key]
             end
-            print_answer(q['prompt'], q['type'], keys.last, res)
+            print_answer(question.prompt, question.type, keys.last, res)
           else
-            print_answer(q['prompt'], q['type'], q['key'], @data[s['key']][:answers])
+            print_answer(question.prompt, question.type, question.key, section.answers)
           end
         end
       end
@@ -197,6 +170,7 @@ module Journal
     end
 
     def save_data
+      @date.localtime
       db = File.expand_path("~/.local/share/journal/#{@key}.json")
       data = if File.exist?(db)
                JSON.parse(IO.read(db))
@@ -206,57 +180,26 @@ module Journal
       date = @date.utc
       output = {}
 
-      @data.each do |k, v|
-        v[:answers].each do |q, a|
-          if a.is_a? Hash
-            output[q] = {}
-            a.each do |key, value|
-              output[q][key] = case value.class.to_s
-                      when /Weather/
-                        { 'high' => value.data[:high], 'low' => value.data[:low], 'condition' => value.data[:condition] }
-                      else
-                        value
-                      end
+      @data.each do |jk, journal|
+        output[jk] = {}
+        journal.answers.each do |k, v|
+          if v.is_a? Hash
+            output[jk][k] = {}
+            v.each do |key, value|
+              output[jk][k][key] = case value.class.to_s
+                               when /Weather/
+                                 { 'high' => value.data[:high], 'low' => value.data[:low], 'condition' => value.data[:condition] }
+                               else
+                                 value
+                               end
             end
           else
-            output[q] = a
+            output[jk][k] = v
           end
         end
       end
       data << { 'date' => date, 'data' => output }
       File.open(db, 'w') { |f| f.puts JSON.pretty_generate(data) }
     end
-
-    def get_number(prompt, min: 1, max: 5)
-      puts "#{prompt} (#{min}-#{max})"
-      res = `gum input --placeholder "#{prompt} (#{min}-#{max})"`.strip
-      return nil if res.strip.empty?
-
-      res = res.to_i
-
-      res = get_number(prompt, min: min, max: max) if res < min || res > max
-      res
-    end
-
-    def get_line(prompt, add_prompt: nil)
-      output = []
-      puts prompt
-      line = `gum input --placeholder "#{prompt} (blank to end editing)"`
-      return output.join("\n") if line =~ /^ *$/
-
-      output << line
-      output << get_line(add_prompt, add_prompt: add_prompt) if add_prompt
-      output.join("\n")
-    end
-
-    def get_lines(prompt, add_prompt: nil)
-      output = []
-      line = `gum write --placeholder "#{prompt}" --width 80 --char-limit 0`
-      return output.join("\n") if line.strip.empty?
-
-      output << line
-      output << get_lines(add_prompt, add_prompt: add_prompt) if add_prompt
-      output.join("\n")
-    end
   end
 end

data/lib/journal-cli/question.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Journal
+  # Individual question
+  class Question
+    attr_reader :key, :type, :min, :max, :prompt, :secondary_prompt
+
+    ##
+    ## Initializes the given question.
+    ##
+    ## @param      question  [Hash] The question with key, prompt, and type, optionally min and max
+    ##
+    ## @return     [Question] the question object
+    ##
+    def initialize(question)
+      @key = question['key']
+      @type = question['type']
+      @min = question['min']&.to_i || 1
+      @max = question['max']&.to_i || 5
+      @prompt = question['prompt']
+      @secondary_prompt = question['secondary_prompt'] || nil
+    end
+
+    ##
+    ## Ask the question, prompting for input based on type
+    ##
+    ## @return     [Number, String] the response based on @type
+    ##
+    def ask
+      case @type
+      when /^(int|num)/i
+        read_number
+      when /^(text|string|line)/i
+        read_line
+      when /^(weather|forecast)/i
+        Weather.new(Journal.config['weather_api'], Journal.config['zip'])
+      when /^multi/
+        read_lines
+      end
+    end
+
+    ##
+    ## Read a numeric entry
+    ##
+    ## @return     [Number] integer response
+    ##
+    def read_number
+      puts "#{@prompt} (#{@min}-#{@max})"
+      res = `gum input --placeholder "#{@prompt} (#{@min}-#{@max})"`.strip
+      return nil if res.strip.empty?
+
+      res = res.to_i
+
+      res = read_number if res < @min || res > @max
+      res
+    end
+
+    ##
+    ## Reads a line.
+    ##
+    ## @param      prompt  [String] If not nil, will trigger
+    ##                     asking for a secondary response
+    ##                     until a blank entry is given
+    ##
+    ## @return     [String] the single-line response
+    ##
+    def read_line(prompt: nil)
+      output = []
+      puts prompt.nil? ? @prompt : @secondary_prompt
+
+      line = `gum input --placeholder "#{@prompt} (blank to end editing)"`
+      return output.join("\n") if line =~ /^ *$/
+
+      output << line
+      output << read_line(prompt: @secondary_prompt) unless @secondary_prompt.nil?
+      output.join("\n").strip
+    end
+
+    ##
+    ## Reads multiple lines.
+    ##
+    ## @param      prompt  [String] if not nil, will trigger
+    ##                     asking for a secondary response
+    ##                     until a blank entry is given
+    ##
+    ## @return     [String] the multi-line response
+    ##
+    def read_lines(prompt: nil)
+      output = []
+      puts prompt.nil? ? @prompt : @secondary_prompt
+      line = `gum write --placeholder "#{prompt}" --width 80 --char-limit 0`
+      return output.join("\n") if line.strip.empty?
+
+      output << line
+      output << read_lines(prompt: @secondary_prompt) unless @secondary_prompt.nil?
+      output.join("\n").strip
+    end
+  end
+end

data/lib/journal-cli/section.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Journal
+  class Section
+    attr_accessor :key, :title, :questions, :answers
+
+    ##
+    ## Initializes the given section.
+    ##
+    ## @param      section  [Hash] The section as defined in
+    ##                      configuration
+    ##
+    ## @return     [Section] the configured section
+    ##
+    def initialize(section)
+      @key = section['key']
+      @title = section['title']
+      @questions = section['questions'].map { |question| Question.new(question) }
+      @answers = {}
+      ask_questions
+    end
+
+    ##
+    ## Ask the questions detailed in the 'questions' section of the configuration
+    ##
+    ## @return [Hash] the question responses
+    ##
+    def ask_questions
+      @questions.each do |question|
+        if question.key =~ /\./
+          res = @answers
+          keys = question.key.split(/\./)
+          keys.each_with_index do |key, i|
+            next if i == keys.count - 1
+
+            res[key] = {} unless res.key?(key)
+            res = res[key]
+          end
+
+          res[keys.last] = question.ask
+        else
+          @answers[question.key] = question.ask
+        end
+      end
+    end
+  end
+end

data/lib/journal-cli/sections.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Journal
+  class Sections < Hash
+    def initialize(sections)
+      sections.each do |sect|
+        section = Section.new(sect)
+        self[section.key] = section
+      end
+      super
+    end
+  end
+end

data/lib/journal-cli/version.rb

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

data/lib/journal-cli.rb

@@ -7,7 +7,26 @@ require 'yaml'
 require 'chronic'
 require 'fileutils'
 
-require_relative "journal-cli/version"
-require_relative "journal-cli/data"
-require_relative "journal-cli/weather"
-require_relative "journal-cli/checkin"
+require_relative 'journal-cli/version'
+require_relative 'journal-cli/data'
+require_relative 'journal-cli/weather'
+require_relative 'journal-cli/checkin'
+require_relative 'journal-cli/sections'
+require_relative 'journal-cli/section'
+require_relative 'journal-cli/question'
+
+# Main Journal module
+module Journal
+  class << self
+    def config
+      unless @config
+        config = File.expand_path('~/.config/journal/journals.yaml')
+        raise StandardError, 'No journals configured' unless File.exist?(config)
+
+        @config = YAML.load(IO.read(config))
+      end
+
+      @config
+    end
+  end
+end

data/src/_README.md

@@ -53,18 +53,19 @@ You can include weather data automatically by setting a question type to 'weathe
 Edit the file at `~/.config/journal/journals.yaml` following this structure:
 
 ```yaml
-daily: # journal key, will be used on the command line as `journal daily`
-  dayone: true # Enable or disable Day One integration
-  journal: Journal # Day One journal to add to (if using Day One integration)
-  markdown: daily # Type of Markdown file to create, false to skip (can be daily, individual, or digest)
-  title: Daily Journal # Title for every entry, date will be appended where needed
-  sections: # Required key
-    - title: null # The title for the section. If null, no section header will be created
-      key: journal # The key for the data collected, must be one word, alphanumeric characters and _ only
-      questions: # Required key
-        - prompt: How are you feeling? # The question to ask
-          key: journal # alphanumeric characters and _ only, will be nested in section key
-          type: multiline # The type of entry expected (numeric, string, or multiline)
+journals:
+  daily: # journal key, will be used on the command line as `journal daily`
+    dayone: true # Enable or disable Day One integration
+    journal: Journal # Day One journal to add to (if using Day One integration)
+    markdown: daily # Type of Markdown file to create, false to skip (can be daily, individual, or digest)
+    title: Daily Journal # Title for every entry, date will be appended where needed
+    sections: # Required key
+      - title: null # The title for the section. If null, no section header will be created
+        key: journal # The key for the data collected, must be one word, alphanumeric characters and _ only
+        questions: # Required key
+          - prompt: How are you feeling? # The question to ask
+            key: journal # alphanumeric characters and _ only, will be nested in section key
+            type: multiline # The type of entry expected (numeric, string, or multiline)
 ```
 
 Keys must be alphanumeric characters and `_` (underscore) only. Titles and questions can be anything, but if they contain a colon (:), you'll need to quote the string.
@@ -125,10 +126,20 @@ A journal must contain a `sections` key, and each section must contain a `questi
 
 Once your configuration file is set up, you can just run `journal JOURNAL_KEY` to begin prompting for the answers to the configured questions. 
 
+If a second argument contains a natural language date, the journal entry will be set to that date instead of the current time. For example, `journal mood "yesterday 5pm"` will create a new entry (in the journal configured for `mood`) for yesterday at 5pm.
+
 Answers will always be written to `~/.local/share/journal/[KEY].json` (where [KEY] is the journal key, one data file for each journal). If you've specified `daily` or `individual` Markdown formats, entries will be written to Markdown files in `~/.local/share/journal/entries/[KEY]`, either in a `%Y-%m-%d.md` file (daily), or in timestamped individual files. If `digest` is specified for the `markdown` key, a single file will be created at `~/.local/share/journal/[KEY].md`.
 
 At present there's no tool for querying the dataset created. You just need to parse the JSON and use your language of choice to extract the data. Numeric entries are stored as numbers, and every entry is timestamped, so you should be able to do some advanced analysis once you have enough data.
 
+### Answering prompts
+
+Questions with numeric answers will have a valid range assigned. Enter just a number within the range and hit return.
+
+Questions with type 'string' or 'text' will save when you hit return. Pressing return without typing anything will leave that answer blank, and it will be ignored when exporting to Markdown or Day One (an empty value will exist in the JSON database).
+
+When using the mutiline type, you'll get an edit field that responds to most control-key navigation and allows insertion and movement. To save a multiline field, press Escape or type CTRL-d.
+
 <!--END README-->
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.10
 platform: ruby
 authors:
 - Brett Terpstra
@@ -174,6 +174,9 @@ files:
 - lib/journal-cli.rb
 - lib/journal-cli/checkin.rb
 - lib/journal-cli/data.rb
+- lib/journal-cli/question.rb
+- lib/journal-cli/section.rb
+- lib/journal-cli/sections.rb
 - lib/journal-cli/version.rb
 - lib/journal-cli/weather.rb
 - src/_README.md