journal-cli 1.0.31 → 1.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68a0dd23d0f640b801ed95ed73796cff7e54445483b95354f3796e64506f2956
-  data.tar.gz: b04e60b7a84fad7d12e674360b2019ff4688ff3b3946c55cf94029d6e770c080
+  metadata.gz: 1c2d45dac4f94f75b5c5cdebd74d5ec1cefa29af7fc56e09ef3682108bc30b62
+  data.tar.gz: ffcf5ca90e17ebd61b04ea5850bc6a55055af61c8611f7310d8b2abbc2606ed8
 SHA512:
-  metadata.gz: 9c9fe623367f3d587ba54526faa9512e1ee22226b7075e270b84985321d8ecad7379da1b511516dd0fb6c1649fc73da1ae833297443607dbfa9e50d721608882
-  data.tar.gz: 1e3521cd6b7aa7834afad83f61bb4df0756c105a2739d35f000bb9cba1eeb9ace56567e765857a180c36be4ce6ee8420d6b61cc397f899c777fe18e62d271888
+  metadata.gz: 3cdd789e27c5c0717bd64d131959a19e3b1a4ec3e89868f44605d75408ab0a92f5c5a77eca11d861c77d16aef1481d50c09aea4db4fefbe535eef86dda7823a3
+  data.tar.gz: '0063039da7e7a33283169dd1f18fa268859d8ce2f9250b9314341e114952c45ae3575472a5c82155115d7f9624322c6f7e739363d460f21e22c4cf23584fa16d'

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 1.0.32
+
+2024-04-20 13:43
+
+#### IMPROVED
+
+- Added note to README that zip codes with leading zero must be quoted
+
+#### FIXED
+
+- Spelling error in weather exception
+
 ### 1.0.31
 
 2023-12-14 09:12

data/Gemfile.lock

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

data/README.md

@@ -35,22 +35,6 @@ If you want to use Day One with Journal, you'll need to [install the Day One CLI
 $ sudo bash /Applications/Day\ One.app/Contents/Resources/install_cli.sh
 ```
 
-## Usage
-
-```
-Usage: journal JOURNAL_KEY [NATURAL LANGUAGE DATE]
-    -v, --version                    Display version
-    -l, --list                       List available journals
-        --[no-]color                 Colorize output
-    -h, --help                       Display help
-
-Available journal types:
-- checkin
-- mood
-- daily
-- test
-```
-
 ## Configuration
 
 A config must be created at `~/.config/journal/journals.yaml`:
@@ -68,9 +52,13 @@ 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.
 
+> Zip codes beginning with zero (0) must be quoted. Use:
+>
+>    zip: '01001'
+
 You can optionally set the key `temp_in:` to `f` or `c` to control what scale is used for temperatures.
 
-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 a question type is set to `weather.forecast`, the moon phase and 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.
 

data/Rakefile

@@ -1,19 +1,19 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rdoc/task'
-require 'standard/rake'
-require 'yard'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rdoc/task"
+require "standard/rake"
+require "yard"
 
 Rake::RDocTask.new do |rd|
   rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
-  rd.title = 'Journal'
+  rd.title = "Journal"
 end
 
 YARD::Rake::YardocTask.new do |t|
- t.files = ['lib/journal-cli/*.rb']
- t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--no-private', '-p', 'yard_templates']
- # t.stats_options = ['--list-undoc']
+  t.files = ["lib/journal-cli/*.rb"]
+  t.options = ["--markup-provider=redcarpet", "--markup=markdown", "--no-private", "-p", "yard_templates"]
+  # t.stats_options = ['--list-undoc']
 end
 
 RSpec::Core::RakeTask.new(:spec) do |t|
@@ -22,8 +22,8 @@ end
 
 task default: %i[test]
 
-desc 'Alias for build'
-task :package => :build
+desc "Alias for build"
+task package: :build
 
 task test: "spec"
 task lint: "standard"
@@ -38,10 +38,10 @@ task :console do
   IRB.start
 end
 
-desc 'Development version check'
+desc "Development version check"
 task :ver do
   gver = `git ver`
-  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  cver = IO.read(File.join(File.dirname(__FILE__), "CHANGELOG.md")).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
   res = `grep VERSION lib/journal-cli/version.rb`
   version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
   puts "git tag: #{gver}"
@@ -49,22 +49,22 @@ task :ver do
   puts "changelog: #{cver}"
 end
 
-desc 'Changelog version check'
+desc "Changelog version check"
 task :cver do
-  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  puts IO.read(File.join(File.dirname(__FILE__), "CHANGELOG.md")).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
 end
 
-desc 'Bump incremental version number'
+desc "Bump incremental version number"
 task :bump, :type do |_, args|
-  args.with_defaults(type: 'inc')
-  version_file = 'lib/journal-cli/version.rb'
+  args.with_defaults(type: "inc")
+  version_file = "lib/journal-cli/version.rb"
   content = IO.read(version_file)
   content.sub!(/VERSION = '(?<major>\d+)\.(?<minor>\d+)\.(?<inc>\d+)(?<pre>\S+)?'/) do
     m = Regexp.last_match
-    major = m['major'].to_i
-    minor = m['minor'].to_i
-    inc = m['inc'].to_i
-    pre = m['pre']
+    major = m["major"].to_i
+    minor = m["minor"].to_i
+    inc = m["inc"].to_i
+    pre = m["pre"]
 
     case args[:type]
     when /^maj/
@@ -81,5 +81,5 @@ task :bump, :type do |_, args|
     $stdout.puts "At version #{major}.#{minor}.#{inc}#{pre}"
     "VERSION = '#{major}.#{minor}.#{inc}#{pre}'"
   end
-  File.open(version_file, 'w+') { |f| f.puts content }
+  File.open(version_file, "w+") { |f| f.puts content }
 end

data/journal-cli.gemspec

@@ -20,24 +20,24 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/main/CHANGELOG.md"
   spec.metadata["github_repo"] = "git@github.com:ttscoff/journal-cli.git"
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'bin'
-  spec.executables   << 'journal'
+  spec.bindir = "bin"
+  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_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"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency('yard', '~> 0.9', '>= 0.9.26')
+  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"
   spec.add_development_dependency "standard", "~> 1.3"
 
-  spec.add_runtime_dependency('chronic', '~> 0.10', '>= 0.10.2')
+  spec.add_runtime_dependency("chronic", "~> 0.10", ">= 0.10.2")
 end

data/lib/journal-cli/array.rb

@@ -2,10 +2,10 @@
 
 class ::Array
   def shortest
-    inject { |memo, word| memo.length < word.length ? memo : word }
+    inject { |memo, word| (memo.length < word.length) ? memo : word }
   end
 
   def longest
-    inject { |memo, word| memo.length > word.length ? memo : word }
+    inject { |memo, word| (memo.length > word.length) ? memo : word }
   end
 end

data/lib/journal-cli/checkin.rb

@@ -9,17 +9,17 @@ module Journal
       @date = Journal.date
       @date.localtime
 
-      raise StandardError, "No journal with key #{@key} found" unless Journal.config['journals'].key? @key
+      raise StandardError, "No journal with key #{@key} found" unless Journal.config["journals"].key? @key
 
-      @journal = Journal.config['journals'][@key]
-      @sections = Sections.new(@journal['sections'])
+      @journal = Journal.config["journals"][@key]
+      @sections = Sections.new(@journal["sections"])
 
       @data = {}
-      meridian = @date.hour < 13 ? 'AM' : 'PM'
-      @title = @journal['title'].sub(/%M/, meridian)
+      meridian = (@date.hour < 13) ? "AM" : "PM"
+      @title = @journal["title"].sub(/%M/, meridian)
     end
 
-    def title(string)
+    def add_title(string)
       @output << "\n## #{string}\n" unless string.nil?
     end
 
@@ -43,11 +43,11 @@ module Journal
       @sections.each { |key, section| @data[key] = section }
 
       save_data
-      save_day_one_entry if @journal['dayone']
+      save_day_one_entry if @journal["dayone"]
 
-      return unless @journal['markdown']
+      return unless @journal["markdown"]
 
-      case @journal['markdown']
+      case @journal["markdown"]
       when /^da(y|ily)/
         save_daily_markdown
       when /^(ind|sep)/
@@ -58,35 +58,35 @@ 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')
+      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')
-      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')
+      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`
+      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)
-            else
-              File.expand_path("~/.local/share/journal/#{@key}/entries")
-            end
+      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)
+      else
+        File.expand_path("~/.local/share/journal/#{@key}/entries")
+      end
 
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
       filename = "#{@key}.md"
       @date.localtime
       target = File.join(dir, filename)
-      File.open(target, 'a') do |f|
+      File.open(target, "a") do |f|
         f.puts
-        f.puts "## #{@title} #{@date.strftime('%x %X')}"
+        f.puts "## #{@title} #{@date.strftime("%x %X")}"
         f.puts
         f.puts to_markdown(yaml: false, title: false)
       end
@@ -94,41 +94,41 @@ module Journal
     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)
-            else
-              File.join(File.expand_path("~/.local/share/journal/#{@key}/entries"))
-            end
+      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)
+      else
+        File.join(File.expand_path("~/.local/share/journal/#{@key}/entries"))
+      end
 
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
       @date.localtime
-      filename = "#{@key}_#{@date.strftime('%Y-%m-%d')}.md"
+      filename = "#{@key}_#{@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) }
+        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) }
+        File.open(target, "w") { |f| f.puts to_markdown(yaml: true, title: true, date: false, time: true) }
       end
       Journal.notify "{bg}Saved daily Markdown to {bw}#{target}"
     end
 
     def save_individual_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')
-            else
-              File.join(File.expand_path('~/.local/share/journal'), @key, 'entries')
-            end
+      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")
+      else
+        File.join(File.expand_path("~/.local/share/journal"), @key, "entries")
+      end
 
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
       @date.localtime
-      filename = @date.strftime('%Y-%m-%d_%H%M.md')
+      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) }
+      File.open(target, "w") { |f| f.puts to_markdown(yaml: true, title: true) }
       puts "Saved new entry to #{target}"
     end
 
@@ -139,17 +139,17 @@ module Journal
       when /^(weather|forecast|moon)/
         header prompt
         @output << case type
-                   when /current$/
-                     data[key].current
-                   when /moon$/
-                     "Moon phase: #{data[key].moon}"
-                   else
-                     data[key].to_markdown
-                   end
+        when /current$/
+          data[key].current
+        when /moon$/
+          "Moon phase: #{data[key].moon}"
+        else
+          data[key].to_markdown
+        end
       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?
+        @output << "#{prompt}: #{data[key].strftime("%Y-%m-%d %H:%M")}" unless data[key].nil?
       else
         unless data[key].strip.empty?
           header prompt
@@ -169,18 +169,18 @@ module Journal
           data[k] = weather_to_yaml(v)
         when /Date/
           v.localtime
-          data[k] = v.strftime('%Y-%m-%d %H:%M')
+          data[k] = v.strftime("%Y-%m-%d %H:%M")
         when /Weather/
           data[k] = case k
-                    when /current$/
-                      v.current
-                    when /forecast$/
-                      data[k] = v.forecast
-                    when /moon(_?phase)?$/
-                      data[k] = v.moon
-                    else
-                      data[k] = v.to_s
-                    end
+          when /current$/
+            v.current
+          when /forecast$/
+            data[k] = v.forecast
+          when /moon(_?phase)?$/
+            data[k] = v.moon
+          else
+            data[k] = v.to_s
+          end
         else
           data[k] = v
         end
@@ -193,34 +193,33 @@ module Journal
 
       if yaml
         @date.localtime
-        yaml_data = { '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
 
         @output << YAML.dump(yaml_data).strip
-        @output << '---'
+        @output << "---"
       end
 
       if title
         if date || time
-          fmt = ''
-          fmt += '%x' if date
-          fmt += '%X' if time
-          title "#{@title} #{@date.strftime(fmt)}"
+          fmt = ""
+          fmt += "%x" if date
+          fmt += "%X" if time
+          add_title "#{@title} #{@date.strftime(fmt)}"
         else
-          title @title
+          add_title @title
         end
       end
 
       @sections.each do |key, section|
-        answers = section.answers
         section section.title
 
         section.questions.each do |question|
-          if question.key =~ /\./
+          if /\./.match?(question.key)
             res = section.answers.dup
-            keys = question.key.split(/\./)
+            keys = question.key.split(".")
             keys.each_with_index do |key, i|
               next if i == keys.count - 1
 
@@ -238,20 +237,20 @@ module Journal
 
     def save_data
       @date.localtime
-      dir = if @journal.key?('entries_folder')
-              File.expand_path(@journal['entries_folder'])
-            elsif Journal.config.key?('entries_folder')
-              File.expand_path(Journal.config['entries_folder'])
-            else
-              File.expand_path('~/.local/share/journal')
-            end
+      dir = if @journal.key?("entries_folder")
+        File.expand_path(@journal["entries_folder"])
+      elsif Journal.config.key?("entries_folder")
+        File.expand_path(Journal.config["entries_folder"])
+      else
+        File.expand_path("~/.local/share/journal")
+      end
       FileUtils.mkdir_p(dir) unless File.directory?(dir)
       db = File.join(dir, "#{@key}.json")
       data = if File.exist?(db)
-               JSON.parse(IO.read(db))
-             else
-               []
-             end
+        JSON.parse(IO.read(db))
+      else
+        []
+      end
       date = @date.utc
       output = {}
 
@@ -261,28 +260,28 @@ module Journal
           if v.is_a? Hash
             v.each do |key, value|
               result = case value.class.to_s
-                       when /Weather/
-                        case key
-                        when /current$/
-                          {
-                            'temp' => value.data[:temp],
-                            'condition' => value.data[:current_condition]
-                          }
-                        when /moon(_?phase)?$/
-                          {
-                            'phase' => value.data[:moon_phase]
-                          }
-                        else
-                          {
-                            'high' => value.data[:high],
-                            'low' => value.data[:low],
-                            'condition' => value.data[:condition],
-                            'moon_phase' => value.data[:moon_phase]
-                          }
-                         end
-                       else
-                         value
-                       end
+              when /Weather/
+                case key
+                when /current$/
+                  {
+                    "temp" => value.data[:temp],
+                    "condition" => value.data[:current_condition]
+                  }
+                when /moon(_?phase)?$/
+                  {
+                    "phase" => value.data[:moon_phase]
+                  }
+                else
+                  {
+                    "high" => value.data[:high],
+                    "low" => value.data[:low],
+                    "condition" => value.data[:condition],
+                    "moon_phase" => value.data[:moon_phase]
+                  }
+                end
+              else
+                value
+              end
               if jk == k
                 output[jk][key] = result
               else
@@ -297,17 +296,17 @@ module Journal
           end
         end
       end
-      data << { 'date' => date, 'data' => output }
+      data << {"date" => date, "data" => output}
       data.map! do |d|
         {
-          'date' => d['date'].is_a?(String) ? Time.parse(d['date']) : d['date'],
-          'data' => d['data']
+          "date" => d["date"].is_a?(String) ? Time.parse(d["date"]) : d["date"],
+          "data" => d["data"]
         }
       end
 
-      data.sort_by! { |e| e['date'] }
+      data.sort_by! { |e| e["date"] }
 
-      File.open(db, 'w') { |f| f.puts JSON.pretty_generate(data) }
+      File.open(db, "w") { |f| f.puts JSON.pretty_generate(data) }
       Journal.notify "{bg}Saved {bw}#{db}"
     end
   end