doing 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb5416a055ea3a013f84f1e53012064b84e05ccc
-  data.tar.gz: 32c01753a8dad864ffc540d1695be3055bdcf665
+  metadata.gz: b8e66a72fd2de31862fdc6423f9771b4a41ac012
+  data.tar.gz: 1bc3c5ab4be017092e802dba802c1a7c1d1721db
 SHA512:
-  metadata.gz: 3cfcdbcbd29bbd129e8aa9928156124f76fcf6f560fd05cdb039c16c49bc47723d5d6d7007e6f6dc469f5390fc10d6f3b26995885fe52cc6a53a30c8eb920d82
-  data.tar.gz: e03184ca58e766fdc00f58fd247388f80d0c3e0ae7af6c4986bc0888b2ddae37930ce74ae8745e75e2404cfb3ca304b83997f03abeb58e85c85c931bdf6e7794
+  metadata.gz: e1b2d0a13c32cb31f971f85afe278138bd7ceffae608f801b3640d23a397474efca6f812830d4089b8220f149f2dc688ef80b680626caac6b98529265f68fe17
+  data.tar.gz: 4536f5c497ef9c2510e81faa08b83786f140d85695ceb757e5233988feaa0ea26fb7f72ff83da9b6d042b6bc2df1b68944b381b1e45708c3a6e0294f0b633301

data/README.md

@@ -16,7 +16,11 @@ _Side note:_ I actually use the library behind this utility as part of another s
 
 ## Installation
 
-    [sudo] gem install doing
+    $ [sudo] gem install doing
+
+Only use `sudo` if your environment requires it. If you're using the system Ruby on a Mac, for example, it will likely be necessary. If `gem install doing` fails, then run `sudo gem install doing` and provide your administrator password.
+
+See the [support](#support) section below for troubleshooting details.
 
 ## The "doing" file
 
@@ -57,16 +61,32 @@ A basic configuration looks like this:
 
 The config file is stored in "~/.doingrc", and is created on the first run. 
 
+### Doing file location
+
 The one thing you'll probably want to adjust is the file that the notes are stored in. That's the `doing_file` key:
 
     doing_file: /Users/username/Dropbox/nvALT2.2/?? What was I doing.md
 
 I keep mine in my nvALT folder for quick access and syncing between machines. If desired, you can give it a `.taskpaper` extension to make it more recognizable to other applications. (If you do that in nvALT, make sure to add `taskpaper` as a recognized extension in preferences).
 
+### "Current actions" section
+
 You can rename the section that holds your current tasks. By default, this is "Currently," but if you have some other bright idea, feel free:
 
     current_section: Currently
 
+### Default editors
+
+The setting `editor_app` only applies to Mac OS X users. It's the default application that the command `doing open` will open your WWID file in. If this is blank, it will be opened by whatever the system default is, or you can use `-a app_name` or `-b bundle_id` to override.
+
+In the case of the `doing now -e` command, your $EDITOR environment variable will be used to complete the entry text and notes. Set it in your .bash_profile or whatever is appropriate for your system:
+
+    export EDITOR="mate -w"
+
+The only requirements are that your editor be launchable from the command line and able to "wait." In the case of Sublime Text and TextMate, just use `-w` like this: `export EDITOR="subl -w"`.
+
+### Templates
+
 The config also contains templates for various command outputs. Include placeholders by placing a % before the keyword. The available tokens are:
 
 - `%title`: the "what was I doing" entry line
@@ -169,7 +189,7 @@ You can create your own "views" in the `~/.doingrc` file and view them with `doi
 You can add additional custom views, just nest them under the "views" key (indented two spaces from the edge). Multiple views would look like this:
 
     views:
-      mine:
+      later:
         section: Later
         count: 5
         wrap_width: 60
@@ -186,6 +206,19 @@ The "section" key is the default section to pull entries from. Count and section
 
 You can add new sections with `done add_section section_name`. You can also create them on the fly by using the `-s section_name` flag when running `doing now`. For example, `doing now -s Misc just a random side note` would create the "just a random side note" entry in a new section called "Misc."
 
+Regarding colors, you can use them to create very nice displays if you're outputting to a color terminal. Example:
+
+    color:
+      date_format: '%F %_I:%M%P'
+      section: Currently
+      count: 10
+      wrap_width: 0
+      template: '%boldblack%date %boldgreen| %boldwhite%title%default%note'
+
+Outputs: 
+
+![](http://ckyp.us/XKpj+)
+
 ## Usage:
 
     doing [global options] command [command options] [arguments...]
@@ -223,4 +256,38 @@ You can add new sections with `done add_section section_name`. You can also crea
     archive  - Move all but the most recent 5 entries to the Archive section
     config   - Edit the default configuration
 
+---
+
+## Troubleshooting
+
+### Errors after "Successfully installed..."
+
+If you get errors in the terminal immediately after a message like:
+
+    Successfully installed doing-x.x.x
+    2 gems installed
+
+...it may just be documentation related. If running `doing` works, you can ignore them. If not, try running the install command again with `--no-document`:
+
+    $ gem install --no-document doing
+
+### Command not found
+
+If running `doing` after a successful install gives you a "command not found" error, then your gem path isn't in your $PATH, meaning the system can't find it. To locate the gem and link it into your path, you can try this:
+
+    cd $GEM_PATH/bin
+    ln -s doing /usr/local/bin/
+
+Then try running `doing` and see if it works.
+
+### Encoding errors
+
+Ruby is rife with encoding inconsistencies across platforms and versions. Feel free to file issues (see below).
+
+### Support
+
+I'm not making any money on `doing`, and I don't plan to spend a lot of time fixing errors on an array of operating systems and platforms I don't even have access to. You'll probably have to solve some things on your own.
+
+That said, you can get support from other users (and occasionally me) on GitHub. If you run into a replicatable issue in your environment, please [post an issue](https://github.com/ttscoff/doing/issues) and include your platform, OS version, and the result of `ruby -v`, along with a copy/paste of the error message.
 
+Please try not to email me directly about GitHub projects.

data/bin/doing

@@ -3,6 +3,11 @@ require 'gli'
 require 'doing'
 require 'tempfile'
 
+if RUBY_VERSION.to_f > 1.9
+  Encoding.default_external = Encoding::UTF_8
+  Encoding.default_internal = Encoding::UTF_8
+end
+
 include GLI::App
 version Doing::VERSION
 
@@ -243,19 +248,32 @@ command :view do |c|
   c.flag [:c,:count], :must_match => /^\d+$/, :type => Integer
 
   c.action do |global_options,options,args|
-    view = wwid.get_view(args[0])
+    if args.empty?
+      title = wwid.choose_view
+    else
+      title = args[0]
+    end
+    view = wwid.get_view(title)
     if view
       template = view.has_key?('template') ? view['template'] : nil
       format = view.has_key?('date_format') ? view['date_format'] : nil
       count = options[:c] ? options[:c] : view.has_key?('count') ? view['count'] : 10
-      section = options[:s] ? options[:s] : view.has_key?('section') ? view['section'] : wwid.current_section
-      puts wwid.list_section({:section => section, :count => count, :template => template, :format => format})
+      section = options[:s] ? options[:s].cap_first : view.has_key?('section') ? view['section'] : wwid.current_section
+      order = view.has_key?('order') ? view['order'] : "asc"
+      puts wwid.list_section({:section => section, :count => count, :template => template, :format => format, :order => order })
     else
-      raise "View #{args[0]} not found in config"
+      raise "View #{title} not found in config"
     end
   end
 end
 
+desc 'List available custom views'
+command :views do |c|
+  c.action do |global_options,options,args|
+    puts wwid.views.join(", ")
+  end
+end
+
 desc 'Move all but the most recent 5 entries in a section to Archive'
 arg_name 'section'
 default_value wwid.current_section

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '0.1.7'
+  VERSION = '0.1.9'
 end

data/lib/doing/wwid.rb

@@ -46,7 +46,8 @@ class WWID
         'template' => '%date | %title%note',
         'wrap_width' => 0,
         'section' => 'section_name',
-        'count' => 5
+        'count' => 5,
+        'order' => "desc"
       },
       'color' => {
           'date_format' => '%F %_I:%M%P',
@@ -54,6 +55,7 @@ class WWID
           'wrap_width' => 0,
           'section' => 'Currently',
           'count' => 10,
+          'order' => "asc"
       }
     }
 
@@ -82,7 +84,7 @@ class WWID
     @other_content_bottom = []
 
     section = "Uncategorized"
-    lines = input.split(/\n/)
+    lines = input.split(/[\n\r]/)
     current = 0
 
     lines.each {|line|
@@ -141,7 +143,7 @@ class WWID
       f.puts input
     end
 
-    pid = Process.fork { system(ENV['EDITOR'], "#{tmpfile.path}") }
+    pid = Process.fork { system("$EDITOR #{tmpfile.path}") }
 
     trap("INT") {
       Process.kill(9, pid) rescue Errno::ESRCH
@@ -153,7 +155,11 @@ class WWID
     Process.wait(pid)
 
     begin
-      input = IO.read(tmpfile.path)
+      if $?.exitstatus == 0
+        input = IO.read(tmpfile.path)
+      else
+        raise "Cancelled"
+      end
     ensure
       tmpfile.close
       tmpfile.unlink
@@ -165,8 +171,8 @@ class WWID
   # This takes a multi-line string and formats it as an entry
   # returns an array of [title(String), note(Array)]
   def format_input(input)
-    return false unless input && input.length > 0
-    input_lines = input.strip.split(/[\n\r]+/)
+    raise "No content in entry" if input.nil? || input.strip.length == 0
+    input_lines = input.split(/[\n\r]+/)
     title = input_lines[0].strip
     note = input_lines.length > 1 ? input_lines[1..-1] : []
     note.map! { |line|
@@ -231,6 +237,20 @@ class WWID
     return sections[num.to_i - 1]
   end
 
+  def views
+    @config.has_key?('views') ? @config['views'].keys : []
+  end
+
+  def choose_view
+    views.each_with_index {|view, i|
+      puts "% 3d: %s" % [i+1, view]
+    }
+    print "> "
+    num = STDIN.gets
+    return false if num =~ /^[a-z ]*$/i
+    return views[num.to_i - 1]
+  end
+
   def get_view(title)
     if @config['views'].has_key?(title)
       return @config['views'][title]
@@ -336,10 +356,11 @@ class WWID
 
   def archive(section=nil,count=10)
     section = choose_section if section.nil? || section =~ /choose/i
+    section = section.cap_first
     if sections.include?(section)
       items = @content[section]['items']
-      return if items.length < 10
-      @content[section]['items'] = items[0..5]
+      return if items.length < count
+      @content[section]['items'] = items[0..count-1]
       add_section('Archive') unless sections.include?('Archive')
       @content['Archive']['items'] += items[count..-1]
       write(@doing_file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,7 +87,7 @@ files:
 - lib/doing.rb
 - lib/doing/version.rb
 - lib/doing/wwid.rb
-homepage: http://brettterpstra.com
+homepage: http://brettterpstra.com/project/doing/
 licenses:
 - MIT
 metadata: {}