journal-cli 1.0.18 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ebc5eaefc846fb4343859ff0148a7798e93e2a4bcc04c5c73ce18151e59ea94
-  data.tar.gz: 87ca031548e115350383a28da8ec853d6d665dd2a9c88ac3ea32105350120785
+  metadata.gz: ac1922ce0228559564036c16e95a4d3042ff0dd36a5eb1137286ec7377b0919b
+  data.tar.gz: 57a0801095a4f5809607819d8eaded1840b4ba5db9ebc41a9090abde76995644
 SHA512:
-  metadata.gz: 7d15d09cce5d189a2d6168e02e9c3122334a88ea9e011b82fa97b0a732901913b6668407f3474211ef6b40b3b068363d9778ff4471a8ded4366089338f3fd7af
-  data.tar.gz: 3bce2d14e6d5f078b481b9d38184e9cd005c336aeecb36bf4a5daa8b7ef66510c60d46d3cd9db97e254266c8c91a07bbf209785b3aedd2d27f6a255e256f0341
+  metadata.gz: c2811f0647206c869d8c7708f90fcdcc0833c3de261d6024bc5ec5a164d2117b25de7d570e4676103e88387ff407fa3a4d8744b6cef6f63c220ad942c1d1c7ad
+  data.tar.gz: d281c93a7d23e567ad0c36d41cd417cd030011f5687f1ffcfcef07f54d01501863cdbf19ad64b2215a25ab9265b4e073cb0c26f9683d4c97868def1577c62e1c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.0.19
+
+2023-09-11 10:52
+
+#### IMPROVED
+
+- Better output of date types in Markdown formats
+
 ### 1.0.18
 
 2023-09-09 12:29

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    journal-cli (1.0.18)
+    journal-cli (1.0.19)
       chronic (~> 0.10, >= 0.10.2)
 
 GEM
@@ -75,6 +75,7 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
     unicode-display_width (2.3.0)
+    yard (0.9.34)
 
 PLATFORMS
   arm64-darwin-21
@@ -94,6 +95,7 @@ DEPENDENCIES
   simplecov (~> 0.21)
   simplecov-console (~> 0.9)
   standard (~> 1.3)
+  yard (~> 0.9, >= 0.9.26)
 
 BUNDLED WITH
    2.4.1

data/README.md

@@ -130,6 +130,16 @@ A journal must contain a `sections` key, and each section must contain a `questi
 
 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.
 
+### Question Types
+
+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
+- `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:

data/Rakefile

@@ -11,7 +11,7 @@ Rake::RDocTask.new do |rd|
 end
 
 YARD::Rake::YardocTask.new do |t|
- t.files = ['lib/na/*.rb']
+ t.files = ['lib/journal-cli/*.rb']
  t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--no-private', '-p', 'yard_templates']
  # t.stats_options = ['--list-undoc']
 end

data/journal-cli.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "gem-release", "~> 2.2"
   spec.add_development_dependency "parse_gemspec-cli", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency('yard', '~> 0.9', '>= 0.9.26')
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.21"
   spec.add_development_dependency "simplecov-console", "~> 0.9"

data/lib/journal-cli/checkin.rb

@@ -135,6 +135,8 @@ module Journal
         hr
       when /^(int|num)/
         @output << "#{prompt}: #{data[key]}  " unless data[key].nil?
+      when /^date/
+        @output << "#{prompt}: #{data[key].strftime('%Y-%m-%d %H:%M')}" unless data[key].nil?
       else
         unless data[key].strip.empty?
           header prompt
@@ -148,8 +150,12 @@ module Journal
       data = {}
       answers.each do |k, v|
         case v.class.to_s
+        when /String/
+          next
         when /Hash/
           data[k] = weather_to_yaml(v)
+        when /Date/
+          data[k] = v.strftime('%Y-%m-%d %H:%M')
         when /Weather/
           data[k] = v.to_s
         else

data/lib/journal-cli/version.rb

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

data/src/_README.md

@@ -133,6 +133,16 @@ A journal must contain a `sections` key, and each section must contain a `questi
 
 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.
 
+### Question Types
+
+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
+- `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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.0.19
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-09 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.26
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement