doing 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 099152d20912d3303aaa11fe984099c26dd658c0
+  data.tar.gz: e8a2977882d97fe1b93a913fbd2a2059f2d2bd43
+SHA512:
+  metadata.gz: 0e33df82c4ada897a07b08e129024b34c357c10438df188cc50a18cd00a9bd9e1ccf029e78448e6ed7993077352c17040533f4cfd39bfc72fb7f6794f58561a0
+  data.tar.gz: 07a8ff1889b6f7f8a7864cdc6561f3ae33cf01f0f1fd884ac135a279342699ab84fd1816485ef79045adf76b0a8dbd1cdeeb6e491098034a8c55b52750890aa3

data/README.rdoc

@@ -0,0 +1,44 @@
+= doing
+
+A basic CLI for adding and listing "what was I doing" reminders in a text file. Allows for multiple sections and flexible output formatting.
+
+The format of the "WWID" file is TaskPaper-compatible. You can edit it by hand at any time, but it uses a specific format for parsing, so be careful. By default the file is created in "~/what_was_i_doing.md", but this can be modified in the config file.
+
+The config file is stored in "~/.doingrc", and is created on the first run. It contains, among other things, templates for various command outputs. Include placeholders by placing a % before the keyword. The available placeholders are:
+
+- %title: the "wwid" entry line
+- %date: the date based on the templates "date_format" setting
+- %shortdate: a custom date formatter that removes the day/month/year from the entry if they match the current day/month/year
+- %note: Any note in the entry will be included here, a newline and tabs are automatically added.
+- %odnote: The notes with a leading tab removed (outdented note)
+- %hr: a horizontal rule (`-`) the width of the terminal
+- %hr_under: a horizontal rule (`_`) the width of the terminal
+
+Date formats are based on Ruby `strftime` formatting.
+
+
+
+Usage:
+
+    doing [global options] command [command options] [arguments...]
+
+Global options:
+
+    --help              - Show this message
+    --[no-]notes        - Output notes if included in the template (default: enabled)
+    --version           - Display the program version
+
+Commands:
+
+    archive  - Archive all but the most recent 5 entries
+    choose   - Select a section to display
+    config   - Edit the default configuration
+    help     - Shows a list of commands or help for one command
+    last     - Show the last entry
+    later    - Add an item to the Later section
+    now      - Add an entry
+    recent   - List recent entries
+    sections - List sections
+    show     - List all entries
+    today    - List entries from today
+

data/bin/doing

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'doing'
+
+include GLI::App
+
+wwid = WWID.new
+
+program_desc 'A CLI for a What Was I Doing system'
+
+version Doing::VERSION
+
+default_command :recent
+sort_help :manually
+
+desc 'Output notes if included in the template'
+default_value true
+switch [:notes], :default_value => true, :negatable => true
+
+# desc 'Wrap notes at X chars (0 for no wrap)'
+# flag [:w,:wrapwidth], :must_match => /^\d+$/, :type => Integer
+
+desc 'Add an entry'
+arg_name 'entry'
+command :now do |c|
+  c.desc 'Section'
+  c.default_value wwid.current_section
+  c.flag [:s,:section]
+
+  c.action do |global_options,options,args|
+    if args.length > 0
+      wwid.add_item(args.join(" ").cap_first, options[:s].cap_first)
+      wwid.write(wwid.doing_file)
+    else
+      raise "You must provide content when creating a new entry"
+    end
+  end
+end
+
+desc 'Add an item to the Later section'
+arg_name 'entry'
+command :later do |c|
+  c.action do |global_options,options,args|
+    if args.length > 0
+      wwid.add_item(args.join(" ").cap_first, "Later")
+      wwid.write(wwid.doing_file)
+    else
+      raise "You must provide content when creating a new entry"
+    end
+  end
+end
+
+desc 'List all entries'
+arg_name 'section'
+command :show do |c|
+  c.action do |global_options,options,args|
+    if args.length > 0
+      if wwid.sections.include? args.join(" ").cap_first
+        section = args.join(" ").cap_first
+      else
+        raise "No such section: #{args.join(" ")}"
+      end
+    else
+      section = wwid.current_section
+    end
+    puts wwid.list_section({:section => section, :count => 0})
+  end
+end
+
+desc 'List recent entries'
+default_value 10
+arg_name 'count'
+command :recent do |c|
+  c.desc 'Section'
+  c.default_value wwid.current_section
+  c.flag [:s,:section]
+  c.action do |global_options,options,args|
+    if args.length > 0
+      count = args[0].to_i
+    else
+      count = 10
+    end
+    puts wwid.recent(count,options[:s].cap_first)
+  end
+end
+
+desc 'List entries from today'
+command :today do |c|
+  c.action do |global_options,options,args|
+    puts wwid.today.strip
+  end
+end
+
+desc 'Show the last entry'
+command :last do |c|
+  c.action do |global_options,options,args|
+    puts wwid.last.strip
+  end
+end
+
+desc 'List sections'
+command :sections do |c|
+  c.action do |global_options,options,args|
+    puts wwid.sections.join(", ")
+  end
+end
+
+desc 'Select a section to display from a menu'
+command :choose do |c|
+  c.action do |global_options,options,args|
+    section = wwid.choose_section
+    puts wwid.list_section({:section => section.cap_first, :count => 0})
+  end
+end
+
+desc 'Move all but the most recent 5 entries to the Archive section'
+default_value wwid.current_section
+arg_name 'section'
+command :archive do |c|
+  c.action do |global_options,options,args|
+    if args.length > 0
+      section = args.join(" ").capitalize
+    else
+      section = wwid.current_section
+    end
+    wwid.archive(section)
+  end
+end
+
+desc 'Edit the default configuration'
+command :config do |c|
+  c.action do |global_options,options,args|
+    system %Q{"#{ENV['EDITOR']}" "#{DOING_CONFIG}"}
+  end
+end
+
+pre do |global,command,options,args|
+  wwid.config[:include_notes] = false unless global[:notes]
+
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/doing.rdoc

@@ -0,0 +1 @@
+= doing

data/lib/doing/version.rb

@@ -0,0 +1,3 @@
+module Doing
+  VERSION = '0.1.3'
+end

data/lib/doing/wwid.rb

@@ -0,0 +1,307 @@
+#!/usr/bin/ruby
+require 'time'
+require 'date'
+require 'yaml'
+require 'pp'
+
+class String
+  def cap_first
+    self.sub(/^\w/) do |m|
+      m.upcase
+    end
+  end
+end
+
+class WWID
+  attr_accessor :content, :sections, :current_section, :doing_file, :config
+
+
+  def initialize(input=nil)
+    @content = {}
+
+    @config = read_config
+
+    @config['doing_file'] ||= "~/what_was_i_doing.md"
+    @config['current_section'] ||= 'Currently'
+
+    @config['templates'] ||= {}
+    @config['templates']['default'] ||= {
+      'date_format' => '%Y-%m-%d %H:%M',
+      'template' => '%date | %title%note',
+      'wrap_width' => 0
+    }
+    @config['templates']['today'] ||= {
+      'date_format' => '%_I:%M%P',
+      'template' => '%date: %title%note',
+      'wrap_width' => 0
+    }
+    @config['templates']['last'] ||= {
+      'date_format' => '%_I:%M%P',
+      'template' => '%date: %title%note',
+      'wrap_width' => 60
+    }
+    @config['templates']['recent'] ||= {
+      'date_format' => '%_I:%M%P',
+      'template' => '%shortdate: %title',
+      'wrap_width' => 60
+    }
+
+    @doing_file = File.expand_path(config['doing_file'])
+    @current_section = config['current_section']
+    @default_template = config['templates']['default']['template']
+    @default_date_format = config['templates']['default']['date_format']
+
+    @config[:include_notes] ||= true
+
+    File.open(File.expand_path(DOING_CONFIG), 'w') { |yf| YAML::dump(config, yf) }
+
+    if input.nil?
+      create(@doing_file) unless File.exists?(@doing_file)
+      input = IO.read(@doing_file)
+      input = input.force_encoding('utf-8') if input.respond_to? :force_encoding
+    elsif File.exists?(File.expand_path(input)) && File.file?(File.expand_path(input)) && File.stat(File.expand_path(input)).size > 0
+      input = IO.read(File.expand_path(input))
+      input = input.force_encoding('utf-8') if input.respond_to? :force_encoding
+      @doing_file = File.expand_path(input)
+    elsif input.length < 256
+      create(input)
+    end
+
+    @other_content_top = []
+    @other_content_bottom = []
+
+    section = "Uncategorized"
+    lines = input.split(/\n/)
+    current = 0
+
+    lines.each {|line|
+      next if line =~ /^\s*$/
+      if line =~ /^(\w[\w ]+):\s*(@\S+\s*)*$/
+        section = $1
+        @content[section] = {}
+        @content[section]['original'] = line
+        @content[section]['items'] = []
+        current = 0
+      elsif line =~ /^\s*- (\d{4}-\d\d-\d\d \d\d:\d\d) \| (.*)/
+        date = Time.parse($1)
+        title = $2
+        @content[section]['items'].push({'title' => title, 'date' => date})
+        current += 1
+      else
+        # if content[section]['items'].length - 1 == current
+          if current == 0
+            @other_content_top.push(line)
+          else
+            if line =~ /^\S/
+              @other_content_bottom.push(line)
+            else
+              unless @content[section]['items'][current - 1].has_key? 'note'
+                @content[section]['items'][current - 1]['note'] = []
+              end
+              @content[section]['items'][current - 1]['note'].push(line)
+            end
+          end
+        # end
+      end
+    }
+  end
+
+  def create(filename=nil)
+    filename = @doing_file
+    unless File.exists?(filename) && File.stat(filename).size > 0
+      File.open(filename,'w+') do |f|
+        f.puts @current_section + ":"
+      end
+    end
+  end
+
+  def read_config
+    if File.exists? File.expand_path(DOING_CONFIG)
+      return YAML.load_file(File.expand_path(DOING_CONFIG))
+    else
+      return {}
+    end
+  end
+
+  def sections
+    @content.keys
+  end
+
+  def add_section(title)
+    @content[title.cap_first] = {'original' => "#{title}:", 'items' => []}
+  end
+
+  def add_item(title,section=nil,opt={})
+    section = @current_section if section.nil?
+    add_section(section) unless @content.has_key?(section)
+    opt[:date] ||= Time.now
+    opt[:note] ||= ""
+
+    entry = {'title' => title.strip.cap_first, 'date' => opt[:date]}
+    unless opt[:note] =~ /^\s*$/s
+      entry['note'] = opt[:note]
+    end
+    @content[section]['items'].push(entry)
+  end
+
+  def write(file=nil)
+    if @other_content_top.empty?
+      output = ""
+    else
+      output = @other_content_top.join("\n") + "\n"
+    end
+    @content.each {|title, section|
+      output += section['original'] + "\n"
+      output += list_section({:section => title, :template => "\t- %date | %title%note"})
+    }
+    output += @other_content_bottom.join("\n")
+    if file.nil?
+      $stdout.puts output
+    else
+      if File.exists?(File.expand_path(file))
+        File.open(File.expand_path(file),'w+') do |f|
+          f.puts output
+        end
+      end
+    end
+  end
+
+  def choose_section
+    sections.each_with_index {|section, i|
+      puts "% 3d: %s" % [i+1, section]
+    }
+    print "> "
+    num = STDIN.gets
+    return false if num =~ /^[a-z ]*$/i
+    return sections[num.to_i - 1]
+  end
+
+  def list_section(opt={})
+    opt[:count] ||= 0
+    count = opt[:count] - 1
+    opt[:section] ||= nil
+    opt[:format] ||= @default_date_format
+    opt[:template] ||= @default_template
+    opt[:order] ||= "desc"
+    opt[:today] ||= false
+
+    if opt[:section].nil?
+      opt[:section] = @content[choose_section]
+    elsif opt[:section].class == String
+      if @content.has_key? opt[:section]
+        opt[:section] = @content[opt[:section]]
+      else
+        $stderr.puts "Section '#{opt[:section]}' not found"
+        return
+      end
+    end
+
+    if opt[:section].class != Hash
+      $stderr.puts "Invalid section object"
+      return
+    end
+
+    items = opt[:section]['items'].sort_by{|item| item['date'] }
+
+    if opt[:today]
+      items.delete_if {|item|
+        item['date'] < Date.today.to_time
+      }.reverse!
+    else
+      items = items.reverse[0..count]
+    end
+
+    items.reverse! if opt[:order] =~ /^asc/i
+
+    out = ""
+
+    items.each {|item|
+      if (item.has_key?('note') && !item['note'].empty?) && @config[:include_notes]
+        note_lines = item['note'].delete_if{|line| line =~ /^\s*$/ }.map{|line| "\t\t" + line.sub(/^\t\t/,'') }
+        if opt[:wrap_width] && opt[:wrap_width] > 0
+          width = opt[:wrap_width]
+          note_lines.map! {|line|
+            line.strip.gsub(/(.{1,#{width}})(\s+|\Z)/, "\t\\1\n")
+          }
+        end
+        note = "\n#{note_lines.join("\n").chomp}"
+      else
+        note = ""
+      end
+      output = opt[:template].dup
+      output.sub!(/%date/,item['date'].strftime(opt[:format]))
+      output.sub!(/%shortdate/) {
+        if item['date'] > Date.today.to_time
+          item['date'].strftime('%_I:%M%P')
+        elsif item['date'] > (Date.today - 7).to_time
+          item['date'].strftime('%a %-I:%M%P')
+        elsif item['date'].year == Date.today.year
+          item['date'].strftime('%b %d, %-I:%M%P')
+        else
+          item['date'].strftime('%b %d %Y, %-I:%M%P')
+        end
+      }
+      output.sub!(/%title/) {|m|
+        if opt[:wrap_width] && opt[:wrap_width] > 0
+          item['title'].gsub(/(.{1,#{opt[:wrap_width]}})(\s+|\Z)/, "\\1\n\t ").strip
+        else
+          item['title'].strip
+        end
+      }
+      output.sub!(/%note/,note)
+      output.sub!(/%odnote/,note.gsub(/\t\t/,"\t"))
+      output.gsub!(/%hr(_under)?/) do |m|
+        o = ""
+        `tput cols`.to_i.times do
+          o += $1.nil? ? "-" : "_"
+        end
+        o
+      end
+      out += output + "\n"
+    }
+
+    return out
+  end
+
+  def archive(section=nil)
+    section = choose_section if section.nil? || section =~ /choose/i
+    if sections.include?(section)
+      items = @content[section]['items']
+      return if items.length < 10
+      @content[section]['items'] = items[0..5]
+      add_section('Archive') unless sections.include?('Archive')
+      @content['Archive']['items'] += items[6..-1]
+      write(@doing_file)
+    end
+  end
+
+  def all(order="")
+    order = "asc" if order == ""
+    cfg = @config['templates']['default_template']
+    list_section({:section => @current_section, :wrap_width => cfg['wrap_width'], :count => 0, :format => cfg['date_format'], :template => cfg['template'], :order => order})
+  end
+
+  def today
+    cfg = @config['templates']['today']
+    list_section({:section => @current_section, :wrap_width => cfg['wrap_width'], :count => 0, :format => cfg['date_format'], :template => cfg['template'], :order => "asc", :today => true})
+  end
+
+  def recent(count=10,section=nil)
+    cfg = @config['templates']['recent']
+    section ||= @current_section
+    list_section({:section => section, :wrap_width => cfg['wrap_width'], :count => count, :format => cfg['date_format'], :template => cfg['template'], :order => "asc"})
+  end
+
+  def last
+    cfg = @config['templates']['last']
+    list_section({:section => @current_section, :wrap_width => cfg['wrap_width'], :count => 1, :format => cfg['date_format'], :template => cfg['template']})
+  end
+
+end
+
+# infile = "~/Dropbox/nvALT2.2/?? What was I doing.md"
+
+# wwid = WWID.new(infile)
+
+# wwid.add_item("Getting freaky with wwid CLI","Currently",{:date => Time.now})
+# wwid.write(infile)

data/lib/doing.rb

@@ -0,0 +1,4 @@
+require 'doing/version.rb'
+require 'doing/wwid.rb'
+
+DOING_CONFIG = "~/.doingrc"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: doing
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Brett Terpstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: A tool for managing a TaskPaper-like file of recent activites. Perfect
+  for the late-night hacker on too much caffeine to remember what they accomplished
+  at 2 in the morning.
+email: me@brettterpstra.com
+executables:
+- doing
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- doing.rdoc
+files:
+- README.rdoc
+- bin/doing
+- doing.rdoc
+- lib/doing.rb
+- lib/doing/version.rb
+- lib/doing/wwid.rb
+homepage: http://brettterpstra.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --title
+- doing
+- --main
+- README.rdoc
+- -ri
+require_paths:
+- lib
+- 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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A command line tool for managing What Was I Doing reminders
+test_files: []