journal-cli 1.0.31 → 1.0.32

data/lib/journal-cli.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-require 'time'
-require 'shellwords'
-require 'json'
-require 'yaml'
-require 'chronic'
-require 'fileutils'
+require "time"
+require "shellwords"
+require "json"
+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/string'
-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'
+require "tty-which"
+require "tty-reader"
+require_relative "journal-cli/version"
+require_relative "journal-cli/color"
+require_relative "journal-cli/string"
+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
@@ -26,9 +26,9 @@ module Journal
 
     def notify(string, debug: false, exit_code: nil)
       if debug
-        $stderr.puts "{dw}#{string}{x}".x
+        warn "{dw}#{string}{x}".x
       else
-        $stderr.puts "#{string}{x}".x
+        warn "#{string}{x}".x
       end
 
       Process.exit exit_code unless exit_code.nil?
@@ -36,35 +36,35 @@ module Journal
 
     def config
       unless @config
-        config = File.expand_path('~/.config/journal/journals.yaml')
+        config = File.expand_path("~/.config/journal/journals.yaml")
         unless File.exist?(config)
           default_config = {
-            'weather_api' => 'XXXXXXXXXXXXXXXXXx',
-            'zip' => 'XXXXX',
-            'entries_folder' => '~/.local/share/journal/',
-            'journals' => {
-              'demo' => {
-                'dayone' => false,
-                'markdown' => 'single',
-                'title' => '5-minute checkin',
-                'entries_folder' => '~/.local/share/journal/',
-                'sections' => [
-                  { 'title' => 'Quick checkin',
-                    'key' => 'checkin',
-                    'questions' => [
-                      { 'prompt' => 'What\'s happening?', 'key' => 'journal', 'type' => 'multiline' }
-                    ] }
+            "weather_api" => "XXXXXXXXXXXXXXXXXx",
+            "zip" => "XXXXX",
+            "entries_folder" => "~/.local/share/journal/",
+            "journals" => {
+              "demo" => {
+                "dayone" => false,
+                "markdown" => "single",
+                "title" => "5-minute checkin",
+                "entries_folder" => "~/.local/share/journal/",
+                "sections" => [
+                  {"title" => "Quick checkin",
+                   "key" => "checkin",
+                   "questions" => [
+                     {"prompt" => "What's happening?", "key" => "journal", "type" => "multiline"}
+                   ]}
                 ]
               }
             }
           }
-          File.open(config, 'w') { |f| f.puts(YAML.dump(default_config)) }
+          File.open(config, "w") { |f| f.puts(YAML.dump(default_config)) }
           puts "New configuration written to #{config}, please edit."
           Process.exit 0
         end
         @config = YAML.load(IO.read(config))
 
-        if @config['journals'].key?('demo')
+        if @config["journals"].key?("demo")
           Journal.notify("{br}Demo journal detected, please edit the configuration file at {bw}#{config}", exit_code: 1)
         end
       end

data/src/_README.md

@@ -38,12 +38,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
-
-```
-@cli(bundle exec bin/journal -h)
-```
-
 ## Configuration
 
 A config must be created at `~/.config/journal/journals.yaml`:
@@ -61,9 +55,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.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journal-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.31
+  version: 1.0.32
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-which
@@ -221,6 +221,7 @@ files:
 - ".github/workflows/version.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile