journal-cli 1.0.20 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5120e9c5386b63b05c8d1e866614db4bc5ce4f46e5e627f6562edb22af812d5d
-  data.tar.gz: 69a663f28a74aa7440d0555038bad8e5273693b33a400125c49df98415c0b2df
+  metadata.gz: 484b18a0188aa705a9941742377f52ac7314fd8ea0e29c01d078df8334368543
+  data.tar.gz: 2c1b6036031cd9d9cabf3fdcafbf923c768730f6420ac1c031d2a9211901650c
 SHA512:
-  metadata.gz: 56d29c600492daeffe8186e34dc1370ac91a0bfbec0cd460986f88d293b2b4a1569d031ef78c7c7faaf3863bbb415d19ce618231969601b932a59db27b110a09
-  data.tar.gz: 1cb774c8c202b213d3aa08babd13ef0b07602f15f4a687150df1a101834f049c23db423cb1716d25bbf9012e7bedab4c9e80ba0934e6f131b8bda4fa9467e67a
+  metadata.gz: c0799f9b88143f38ca52b515de35453e2edbbd6b97325e1a0e0c9c4748014995ca15e3423be014b129234573daaca82d769ca16e0c541a3e8d4976492e9984db
+  data.tar.gz: 5164b850be461d04c6a81f83c4b0ec3b278fffbabbf61b60926813e19ce1f89cd66310ed5913d62887839fe2c0c6734769bb93efd2fed37396b97f20eadeccaf

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.0.21
+
+2023-09-13 11:00
+
+#### IMPROVED
+
+- If gum is installed, continue using it, but no longer require gum to function
+
 ### 1.0.20
 
 2023-09-12 19:10

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    journal-cli (1.0.20)
+    journal-cli (1.0.21)
       chronic (~> 0.10, >= 0.10.2)
+      tty-reader (~> 0.9, >= 0.9.0)
+      tty-which (~> 0.5, >= 0.5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -74,7 +76,15 @@ GEM
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
+    tty-cursor (0.7.1)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-which (0.5.0)
     unicode-display_width (2.3.0)
+    wisper (2.0.1)
     yard (0.9.34)
 
 PLATFORMS

data/README.md

@@ -9,12 +9,6 @@ The `journal` command reads a journal definition and provides command line promp
 
 ## Installation
 
-First, you need [Gum](https://github.com/charmbracelet/gum) installed. The easiest way is with [Homebrew](https://brew.sh/):
-
-```
-$ brew install gum
-```
-
 Use RubyGems to install journal:
 
 ```
@@ -29,7 +23,17 @@ $ gem install --user-install journal-cli
 
 > I've noticed lately with `asdf` that I have to run `asdf reshim` after installing gems containing binaries.
 
-If you want to use Day One with journal, you'll need to [install the Day One CLI](https://dayoneapp.com/guides/tips-and-tutorials/command-line-interface-cli/).
+If [Gum](https://github.com/charmbracelet/gum) is installed, it will be used for prettier input prompts and editing. The easiest way is with [Homebrew](https://brew.sh/):
+
+```
+$ brew install gum
+```
+
+If you want to use Day One with Journal, you'll need to [install the Day One CLI](https://dayoneapp.com/guides/tips-and-tutorials/command-line-interface-cli/). It's just one command:
+
+```
+sudo bash /Applications/Day\ One.app/Contents/Resources/install_cli.sh
+```
 
 ## Configuration
 
@@ -137,12 +141,13 @@ 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
-- `integer` or `number` will request numeric input
+- `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
 
 ### 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:
+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:
 
 ```json
 {

data/journal-cli.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   << 'journal'
   spec.require_paths << "lib"
 
+  spec.add_runtime_dependency('tty-which', '~> 0.5', '>= 0.5.0')
+  spec.add_runtime_dependency('tty-reader', '~> 0.9', '>= 0.9.0')
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "gem-release", "~> 2.2"
   spec.add_development_dependency "parse_gemspec-cli", "~> 1.0"

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
+    attr_reader :key, :type, :min, :max, :prompt, :secondary_prompt, :gum
 
     ##
     ## Initializes the given question.
@@ -19,6 +19,7 @@ module Journal
       @max = question['max']&.to_i || 5
       @prompt = question['prompt'] || nil
       @secondary_prompt = question['secondary_prompt'] || nil
+      @gum = TTY::Which.exist?('gum')
     end
 
     ##
@@ -30,15 +31,17 @@ module Journal
       return nil if @prompt.nil?
 
       case @type
-      when /^(int|num)/i
+      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'])
-      when /^multi/
+      when /^multi/i
         read_lines
-      when /^date/
+      when /^(date|time)/i
         read_date
       end
     end
@@ -46,24 +49,28 @@ module Journal
     private
 
     ##
-    ## Read a numeric entry
+    ## Read a numeric entry using gum or TTY::Reader
+    ##
+    ## @param      [Boolean] integer  Round result to nearest integer
     ##
     ## @return     [Number] integer response
     ##
-    def read_number
+    ##
+    def read_number(integer: false)
       Journal.notify("{by}#{@prompt} {c}({bw}#{@min}{c}-{bw}#{@max})")
-      res = `gum input --placeholder "#{@prompt} (#{@min}-#{@max})"`.strip
-      return nil if res.strip.empty?
 
-      res = res.to_f
+      res = @gum ? read_number_gum : read_line_tty
+
+      res = integer ? res.to_f.round : res.to_f
 
       res = read_number if res < @min || res > @max
       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)"`
+      prompt ||= @prompt
+      Journal.notify("{by}#{prompt} (natural language)")
+      line = @gum ? read_line_gum(prompt) : read_line_tty
       Chronic.parse(line)
     end
 
@@ -78,9 +85,10 @@ module Journal
     ##
     def read_line(prompt: nil)
       output = []
-      Journal.notify("{by}#{prompt.nil? ? @prompt : @secondary_prompt}")
+      prompt ||= @prompt
+      Journal.notify("{by}#{prompt}")
 
-      line = `gum input --placeholder "#{@prompt} (blank to end editing)"`
+      line = @gum ? read_line_gum(prompt) : read_line_tty
       return output.join("\n") if line =~ /^ *$/
 
       output << line
@@ -99,13 +107,75 @@ module Journal
     ##
     def read_lines(prompt: nil)
       output = []
-      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`
+      prompt ||= @prompt
+      Journal.notify("{by}#{prompt} {c}({bw}CTRL-d{c} to save)'")
+      line = @gum ? read_multiline_gum(prompt) : read_mutliline_tty
       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
+
+    ##
+    ## Read a numeric entry using gum
+    ##
+    ## @param      [Boolean] integer  Round result to nearest integer
+    ##
+    ## @return     [Number] integer response
+    ##
+    ##
+    def read_number_gum
+      res = `gum input --placeholder "#{@min}-#{@max}"`.strip
+      return nil if res.strip.empty?
+
+      res
+    end
+
+    ##
+    ## Read a single line entry using TTY::Reader
+    ##
+    ## @param      [Boolean] integer  Round result to nearest integer
+    ##
+    ## @return     [Number] integer response
+    ##
+    def read_line_tty
+      reader = TTY::Reader.new
+      res = reader.read_line('>> ')
+      return nil if res.strip.empty?
+
+      res
+    end
+
+    ##
+    ## Read a single line entry using gum
+    ##
+    ## @param      [Boolean] integer  Round result to nearest integer
+    ##
+    ## @return     [Number] integer response
+    ##
+    def read_line_gum(prompt)
+      `gum input --placeholder "#{prompt} (blank to end answer)"`
+    end
+
+    ##
+    ## Read a multiline entry using TTY::Reader
+    ##
+    ## @return     [string] multiline input
+    ##
+    def read_mutliline_tty
+      reader = TTY::Reader.new
+      res = reader.read_multiline
+      res.join("\n")
+    end
+
+    ##
+    ## Read a multiline entry using gum
+    ##
+    ## @return     [string] multiline input
+    ##
+    def read_multiline_gum(prompt)
+      `gum write --placeholder "#{prompt}" --width 80 --char-limit 0`
+    end
   end
 end

data/lib/journal-cli/version.rb

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

data/lib/journal-cli.rb

@@ -7,6 +7,8 @@ require 'yaml'
 require 'chronic'
 require 'fileutils'
 
+require 'tty-which'
+require 'tty-reader'
 require_relative 'journal-cli/version'
 require_relative 'journal-cli/color'
 require_relative 'journal-cli/data'

data/src/_README.md

@@ -12,12 +12,6 @@ The `journal` command reads a journal definition and provides command line promp
 
 ## Installation
 
-First, you need [Gum](https://github.com/charmbracelet/gum) installed. The easiest way is with [Homebrew](https://brew.sh/):
-
-```
-$ brew install gum
-```
-
 Use RubyGems to install journal:
 
 ```
@@ -32,7 +26,17 @@ $ gem install --user-install journal-cli
 
 > I've noticed lately with `asdf` that I have to run `asdf reshim` after installing gems containing binaries.
 
-If you want to use Day One with journal, you'll need to [install the Day One CLI](https://dayoneapp.com/guides/tips-and-tutorials/command-line-interface-cli/).
+If [Gum](https://github.com/charmbracelet/gum) is installed, it will be used for prettier input prompts and editing. The easiest way is with [Homebrew](https://brew.sh/):
+
+```
+$ brew install gum
+```
+
+If you want to use Day One with Journal, you'll need to [install the Day One CLI](https://dayoneapp.com/guides/tips-and-tutorials/command-line-interface-cli/). It's just one command:
+
+```
+sudo bash /Applications/Day\ One.app/Contents/Resources/install_cli.sh
+```
 
 ## Configuration
 
@@ -140,12 +144,13 @@ 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
-- `integer` or `number` will request numeric input
+- `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
 
 ### 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:
+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:
 
 ```json
 {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.20
+  version: 1.0.21
 platform: ruby
 authors:
 - Brett Terpstra
@@ -10,6 +10,46 @@ bindir: bin
 cert_chain: []
 date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: tty-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement