done_log 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa9087eac5309de9a13842028ba9d4414a31019914c288a4f6708b20a77fe12e
+  data.tar.gz: c95a79c7b8a1ebc63f831829f387d509f3872004b78defc139e84f985cddacd0
+SHA512:
+  metadata.gz: 50203c3aafcd8719de41afda937b5859bd6b27d730d9688b57dd291e03a411b351c975ec124fe6d415af707a4bf9702053b27a6d8218b282a99aa1a9afe0370a
+  data.tar.gz: a4471793fc7b925e611957c8b81c28c77771c4ac42377e2b21202d2096c7d9fe51272be5029bbd409affa00a153d17a9bea0f4f081b10b33fc08d08d3fc1ab13

data/README.md

@@ -0,0 +1,89 @@
+## Done
+
+This is a dumb Ruby script to help manage daily work logs.
+
+Keeps each day in a separate file.
+
+Keeps the files in a Git repository.
+
+Edits the logs via `vim`.
+
+Trailing newlines stripped automatically from logs.
+
+Optionally pushes to a remote Git repository.
+
+### Installing
+
+This is a Ruby program, so you'll need [a Ruby](https://www.ruby-lang.org/) first.
+
+Via RubyGems:
+
+    gem install done_log
+
+From source:
+
+    git clone https://github.com/presidentbeef/done_log.git
+    gem build done_log.gemspec
+    gem install done_log*.gem
+
+### Configuration 
+
+Logs are kept in `~/.done/log/`.
+
+This directory is created automatically.
+
+Configuration is read from JSON file `~/.done/config`.
+
+A default configuration file is created automatically.
+
+Options are:
+
+* `git_repo` which can be set to a remote Git repository.
+* `date_color` which sets the color used for dates when viewing logs.
+
+[Possible colors listed here](https://github.com/presidentbeef/done_log/blob/master/lib/done_log/ansi_colors.rb#L4-L12),
+plus they can be prefixed by `bright_`.
+
+### Running
+
+`done_log` edits the log for the current day.
+
+`done_log -[N]` edits the log for the previous `N` day. `-1` is yesterday, `-2` is two days ago, etc.
+
+`done_log -d DATE` edits the log for the specified date.
+
+`done_log -s -d DATE` shows the specified log.
+
+`done_log --sprint` shows the last 14 days of logs.
+
+### Logging
+
+#### Start a Log
+
+To enter a log for today, run `done_log`.
+
+To enter a log for yesterday, run `done_log -1`
+
+To enter a log for a specific date, run `done_log -d DATE`.
+
+#### Edit a Log
+
+When editing, `vim` is opened to a new/existing document. When `vim` exits, the log is committed and pushed to the Git repo.
+
+To cancel a new log, delete _everything_ in the file and save.
+
+To cancel edits to an existing log, close `vim` without saving.
+
+#### Review a Log
+
+To view an existing log, use `-s` or `--show`.
+
+Examples:
+
+* `done_log --show --date DATE`
+* `done_log -s -d DATE`
+* `done_log -s -1` (Show yesterday's log)
+
+### License
+
+MIT

data/bin/done_log

@@ -0,0 +1,14 @@
+#!/bin/env ruby
+require 'date'
+require_relative '../lib/done_log.rb'
+
+options = Done::Options.parse!(ARGV)
+
+case options[:action]
+when :edit
+  Done::Log.edit_logs(options[:time_period])
+when :show
+  Done::Log.show_logs(options[:time_period], options[:date_color])
+else
+  abort "Need to either --edit or --show logs"
+end

data/lib/done_log.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'fileutils'
+require 'json'
+require_relative 'done_log/git_repo'
+require_relative 'done_log/options'
+require_relative 'done_log/ansi_colors'
+
+module Done
+  class Log
+    attr_reader :date, :dir, :git, :log_file
+
+    def initialize date:, date_color: nil
+      @date = date
+      @dir = Done::Log.default_log_dir
+      year = date.year.to_s
+      month = date.month.to_s.rjust(2, "0")
+      @log_file = File.join(dir, year, month, date_string)
+
+      config = Done::Log.config
+      @git = GitRepo.new(config[:git_repo], dir, log_file)
+      @date_color = date_color || config[:date_color]
+    end
+
+    def log
+      ensure_directory
+      git.pull
+      create_log
+      vim_edit
+      strip_log
+      git.add
+      git.commit
+      git.push
+    end
+
+    def show pull = true
+      ensure_directory
+      git.pull if pull
+
+      if File.exist? log_file
+        log = File.read(log_file)
+        if $stdout.tty?
+          puts log.sub(/^(\d{4}-\d{2}-\d{2})$/) { |date| Done::ANSIColors.colorize(date, @date_color) }
+        else
+          puts log
+        end
+
+        puts
+      else
+        puts <<~LOG
+      #{Done::ANSIColors.colorize(date_string, @date_color)}
+
+      [No log]
+
+        LOG
+      end
+    end
+
+    def ensure_directory
+      FileUtils.mkdir_p(File.dirname(log_file))
+      git.init
+    end
+
+    def create_log
+      unless File.exist? log_file
+        File.open(log_file, "w") do |f|
+          f.puts <<~LOG
+          #{date_string}
+
+          LOG
+        end
+
+        git.add
+      end
+    end
+
+    def strip_log
+      log = File.read(log_file).strip
+
+      if log.empty?
+        File.delete(log_file)
+      else
+        File.open(log_file, "w") do |f|
+          f.puts log
+        end
+      end
+    end
+
+    def vim_edit
+      system 'vim',
+        '+ normal Go', # Move to end of file, start new line
+        '+startinsert', # Switch to insert mode
+        log_file
+    end
+
+    def date_string
+      date.iso8601.freeze
+    end
+
+    class << self 
+      def default_dir
+        File.join(Dir.home, ".done").freeze
+      end
+
+      def default_log_dir
+        File.join(Dir.home, ".done", "log").freeze
+      end
+
+      def logs
+        Dir[self.default_dir].sort
+      end
+
+      def config config_file = default_config_file
+        if File.exist? config_file
+          begin
+            JSON.parse(File.read(config_file), symbolize_names: true)
+          rescue JSON::ParserError => e
+            warn "Unable to parse config file: #{e.inspect}"
+            {}
+          end
+        else
+          FileUtils.mkdir_p(default_dir)
+
+          config = default_config
+          puts "What Git URL (e.g. git@github.com:user_name/example_log.git) should we use?\nLeave blank to skip."
+          print "? "
+          url = gets.strip
+
+          unless url.empty?
+            config[:git_repo] = url
+          end
+
+          File.open(config_file, "w") do |f|
+            f.puts(JSON.pretty_generate(config))
+          end
+
+          config
+        end
+      end
+
+      def default_config
+        {
+          git_repo: nil,
+          date_color: :cyan
+        }
+      end
+
+      def default_config_file
+        File.join(default_dir, "config")
+      end
+
+      def edit_logs time_period
+        if time_period.is_a? Date
+          Done::Log.new(date: time_period).log
+        else
+          time_period.each do |d|
+            Done::Log.new(date: d).log
+          end
+        end
+      end
+
+      def show_logs time_period, date_color = nil
+        if time_period.is_a? Date
+          Done::Log.new(date: time_period, date_color: date_color).show
+        else
+          pull = true
+          time_period.each do |d|
+            Done::Log.new(date: d, date_color: date_color).show(pull)
+            pull = false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/done_log/ansi_colors.rb

@@ -0,0 +1,38 @@
+module Done
+  module ANSIColors
+    Colors = {
+      none: 0,
+      black: 30,
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      magenta: 35,
+      cyan: 36,
+      white: 37,
+    }.freeze
+
+    def self.colorize input, color
+      return input unless color
+
+      color = color.to_sym
+
+      if color == :none
+        return input
+      end
+
+      color_code = if color.start_with? 'bright'
+                     code = Colors[color.to_s.split('_').last.to_sym]
+                     "#{code};1"
+                   else
+                     Colors[color.to_sym]
+                   end
+
+      "\e[#{color_code}m#{input}\e[0m"
+    end
+
+    def self.colors
+      @colors ||= Colors.keys.concat(Colors.keys.map { |c| "bright_#{c}".to_sym })
+    end
+  end
+end

data/lib/done_log/git_repo.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Done
+  class GitRepo
+    attr_reader :git_url, :log_dir, :log_file
+
+    def initialize git_url, log_dir, log_file
+      @git_url = git_url
+      @log_dir = log_dir
+      @log_file = log_file
+    end
+
+    def add
+      unless File.empty? log_file
+        run "git add #{log_file}"
+      end
+    end
+
+    def commit
+      unless run "git diff --no-patch --cached --exit-code" # Check if there are any changes
+        unless run "git commit #{log_file} -m 'Update #{File.basename log_file}'"
+          raise 'Could not commit update to git'
+        end
+      end
+    end
+
+    def has_remote?
+      run "git remote -v | grep -q -F #{git_url.inspect}"
+    end
+
+    def init
+      if git_url and not Dir.exist? log_dir
+        run "git clone -q #{git_url} #{log_dir}"
+      else
+        run "git init -q #{log_dir}"
+      end
+    end
+
+    def pull
+      return unless git_url
+      return unless has_remote?
+
+      unless run 'git pull -q'
+        raise 'Could not pull from git'
+      end
+    end
+
+    def push
+      return unless git_url
+      return unless has_remote?
+
+      unless run 'git push'
+        raise 'Could not push to git'
+      end
+    end
+
+    def run cmd
+      FileUtils.cd(log_dir) do
+        system cmd
+      end
+    end
+  end
+end

data/lib/done_log/options.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'optparse/date'
+require_relative 'ansi_colors'
+
+module Done
+  class Options
+    def self.parse!(args)
+      options = {}
+
+      days = args.grep(/^-\d+$/)
+
+      unless days.empty?
+        if days.length > 1
+          raise "Expected only one day, got #{days.inspect}"
+        end
+
+        days = days.first
+        args.delete days
+        options[:time_period] = Date.today - days.to_i.abs
+        options[:action] ||= :edit
+      end
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: done_log [options]"
+
+        opts.on "-NUM", OptionParser::DecimalInteger, "Go back NUM days"
+
+        opts.on "-e", "--edit", "Edit log(s)" do
+          options[:action] = :edit
+        end
+
+        opts.on "-s", "--show", "Display log(s)" do
+          options[:action] = :show
+        end
+
+        opts.on "-d", "--date [DATE]", Date, "Select date" do |date|
+          options[:time_period] = date
+        end
+
+        opts.on "--sprint", "Last 14 days" do
+          options[:time_period] = (Date.today - 14)..Date.today
+          options[:action] ||= :show
+        end
+
+        opts.on "-c", "--color-date COLOR", Done::ANSIColors.colors, "Set color for dates" do |color|
+          options[:date_color] = color.to_sym
+        end
+
+        opts.on_tail "-h", "--help", "Show this message" do
+          puts opts
+          exit
+        end
+      end.parse(args)
+
+      default_options.merge(options)
+    end
+
+    def self.default_options
+      {
+        action: :edit,
+        time_period: Date.today
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: done_log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies: []
+description: Manage very simple daily work logs in text files.
+email: 
+executables:
+- done_log
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/done_log
+- lib/done_log.rb
+- lib/done_log/ansi_colors.rb
+- lib/done_log/git_repo.rb
+- lib/done_log/options.rb
+homepage: https://github.com/presidentbeef/done_log
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/presidentbeef/done_log
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Extremely simple daily log.
+test_files: []