bullet_journal 0.0.1.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3dc11e763d39307602e0df60912439b1ee28d60d1dec9e4ee0472c09368ff659
+  data.tar.gz: 886df135acffc8c6ac48fa14c12228fc5edf9d83eec66a6fdd46b782cac2d422
+SHA512:
+  metadata.gz: 1ac2723e346c3be1f79c237d972f0d7d5bc9a113c39ea82ceb248816ccd2870a05591f3b59a26c0392462aeeb6766a65dc12ce91f17ac370717f290b645373e9
+  data.tar.gz: f84a93df1cd82de5c2d98530481e9f0824ef913f713a651822b4ceb7f17156c76730e3674221f501e1161a68d92a1c7f06aed6608ca294a75ed8994975018a6f

data/bin/jo

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'bullet_journal'
+require 'pathname'
+
+journal = BulletJournal.new(args: ARGV)
+
+# So, you're probably wondering...
+# `system` vs `exec`
+# Well, exec effectively ends this process and
+# launches your new one. System returns back to
+# ruby once it's finished. This may have a memory/cpu
+# penalty but I'm not sure. I can worry about that later.
+# (there may be an upcoming reason why I would like to
+# return to ruby once vim has closed, but I'm forgetting
+# it right now)
+
+#exec "nvim #{file_name}"
+
+puts "Bullet journal file:"
+puts "  #{journal.full_path}"
+
+# we can't open a file until it exists, so
+# let's make sure it does
+if (journal.editor == 'open')
+  `touch #{journal.full_path}` unless Pathname.new(journal.full_path).exist?
+end
+
+system "#{journal.editor} #{journal.full_path}" unless journal.editor == "none"
+

data/lib/bullet_journal.rb

@@ -0,0 +1,67 @@
+class BulletJournal
+  def initialize(args: [],
+                 day: BulletJournal::Day.new,
+                 config: BulletJournal::Config.new)
+
+    @day = day
+    @someday = false
+    @config = config
+    parse_args(args)
+  end
+
+  def full_path
+    File.join(@config.journal_location(name), path)
+  end
+
+  def path
+    return "#{name}_Someday.md" if @someday
+
+    "#{name}_#{@day}.md"
+  end
+
+  def name
+    @name ||= @config.default_journal_name
+  end
+
+  def editor
+    @config.editor(name)
+  end
+
+  def weekdays
+    #todo i18n
+    %w[monday tuesday wednesday thursday friday saturday sunday]
+  end
+
+  private
+    def parse_args(args)
+      return if args.empty?
+
+      first_arg = args.shift.downcase
+      case first_arg
+        when "someday"
+          @someday = true
+        when "today"
+        when "yesterday"
+          @day.yesterday!
+        when "tomorrow"
+          @day.tomorrow!
+        when "last"
+          @day.previous!(args.shift.downcase)
+        when "next"
+          @day.next!(args.shift.downcase)
+        when *weekdays
+          @day.next!(first_arg)
+        else
+          args.unshift(first_arg)
+      end
+      parse_name(args)
+    end
+
+    def parse_name(name_args)
+      return if name_args.length == 0
+      @name = name_args.join('-').upcase
+    end
+end
+
+require 'bullet_journal/day.rb'
+require 'bullet_journal/config.rb'

data/lib/bullet_journal/config.rb

@@ -0,0 +1,67 @@
+require 'yaml'
+require 'pathname'
+require 'bullet_journal/logger'
+
+class BulletJournal::Config
+  def initialize(
+      file: "~/.config/bullet_journal/config.yml",
+      logger: BulletJournal::Logger.new)
+
+    @logger = logger
+    file = File.expand_path(file) # macOS needs this
+
+    unless Pathname.new(file).exist?
+      create_initial_config(file)
+    end
+
+    begin
+      @config_file = YAML.load_file(file)
+      @logger.info "Loaded config:\n  #{file}"
+    rescue
+      @config_file = {}
+      @logger.error "Unable to load config file."
+    end
+
+    @logger.info "Default journal name:\n  #{default_journal_name}"
+    @logger.info "Default journal location:\n  #{journal_location}"
+    @logger.info "Default editor:\n  #{editor}"
+    @logger.info
+  end
+
+  def default_journal_name
+    journal.fetch('journal_name', 'JOURNAL')
+  end
+
+  def journal_location(journal_name = nil)
+    journal_name ||= "default"
+    journal(journal_name)
+      .fetch('journal_location',
+        journal.fetch('journal_location', "."))
+  end
+
+  def editor(journal_name = "default")
+    journal_name == "default" if journal_name == default_journal_name
+    journal(journal_name)
+      .fetch('editor',
+        journal.fetch('editor', 'vim'))
+  end
+
+  private
+    def journal(name = "default")
+      @config_file.fetch(name.downcase, {})
+    end
+
+    def create_initial_config(file)
+      @logger.info "Writing default config file."
+      pathname = Pathname(file)
+      pathname.dirname.mkpath
+      pathname.write(%{default:
+  journal_name: "JOURNAL"
+  journal_location: "."
+  editor: "vim"
+})
+      @logger.info "Default config file written."
+    rescue
+      @logger.error "Unable to write default config file."
+    end
+end

data/lib/bullet_journal/day.rb

@@ -0,0 +1,37 @@
+class BulletJournal::Day
+  def initialize(time = Time.now)
+    @time = time
+  end
+
+  def to_s
+    @time.strftime("%Y-%m-%d_%A")
+  end
+
+  def day_name
+    @time.strftime("%A")
+  end
+
+  def yesterday!
+    @time -= 86400
+  end
+
+  def tomorrow!
+    @time += 86400
+  end
+
+  def previous!(requested_day_name)
+    #todo fix i18n
+    requested_day_name = "friday" if requested_day_name == "week"
+    begin
+      yesterday!
+    end while day_name.downcase != requested_day_name
+  end
+
+  def next!(requested_day_name)
+    #todo fix i18n
+    requested_day_name = "monday" if requested_day_name == "week"
+    begin
+      tomorrow!
+    end while day_name.downcase != requested_day_name
+  end
+end

data/lib/bullet_journal/logger.rb

@@ -0,0 +1,18 @@
+class BulletJournal::Logger
+  def initialize(enabled: true)
+    @enabled = enabled
+  end
+
+  def info(message = "")
+    log(message)
+  end
+
+  def error(message = "")
+    log "[error] #{message}"
+  end
+
+  private
+    def log(message)
+      puts message if @enabled
+    end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: bullet_journal
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha.1
+platform: ruby
+authors:
+- Rob Gough
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-19 00:00:00.000000000 Z
+dependencies: []
+description: Helper utility for managing bullet journal style markdown files via the
+  terminal
+email: bullet_journal@robgough.net
+executables:
+- jo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/jo
+- lib/bullet_journal.rb
+- lib/bullet_journal/config.rb
+- lib/bullet_journal/day.rb
+- lib/bullet_journal/logger.rb
+homepage: https://robgough.net/bullet-journal
+licenses: []
+metadata:
+  source_code_uri: https://github.com/robgough/bullet_journal
+  changelog_uri: https://github.com/robgough/bullet_journal/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Helper util for bullet journaling
+test_files: []