posto 0.3.3 → 0.3.4

data/README.md

@@ -2,6 +2,18 @@
 
 Sort your todo list from the command line.
 
+## Tutorial
+
+After adding `gem "posto"` to your Gemfile, `bundle install`
+
+To initialize a posto file, `posto init` 
+
+To add a task, `posto add "an example task"`
+
+To see current tasks, `posto`
+
+To see a full list of commands, click [here](https://github.com/mattraibert/posto/blob/master/lib/posto/help.md).
+
 ## Naming
 
 Posto is named for [Del Posto](http://www.delposto.com/) in New York City -- a restaurant that has been on my todo list for quite a while.

data/lib/posto/application.rb

@@ -1,5 +1,6 @@
 require 'posto/list'
 require 'posto/file'
+require 'posto/help'
 
 module Posto
   class Application
@@ -14,6 +15,10 @@ module Posto
       @todos = todos
     end
 
+    def help
+      @io.puts Posto::Help.help_text
+    end
+
     def run
       @io.puts send(@arguments.command, *@arguments.params)
     end

data/lib/posto/arguments.rb

@@ -13,19 +13,7 @@ module Posto
     end
 
     def filename
-      read_flag("-f") || "posto.md"
-    end
-
-    def read_flag(flag)
-      filename_index = @args.index(flag)
-      unless filename_index.nil?
-        @args.delete_at(filename_index)
-        @args.delete_at(filename_index)
-      end
-    end
-
-    def to_s
-      @args.inspect
+      "posto.md"
     end
   end
 end

data/lib/posto/help.md

@@ -0,0 +1,26 @@
+### List Commands
+
+`init`: create a 'posto.md' file in the working directory.
+
+`list`, `todos`, `[default]`: display the todo list.
+
+`sort`: ask the user about priorities to sort todos.
+
+`resort`: reset sort order and sort again (can be time consuming).
+
+
+### Single Todo Commands
+
+`add '<todo>'`: add <todo> unsorted to the bottom of the todo list.
+
+`start '<todo>'`: add, sort and commit with a message based on <todo>.
+
+`done [n = 1]`, `delete [n]`: remove the nth todo from the list.
+
+`commit [n]`: remove the nth todo; commit with a message based on the todo.
+
+`do`, `top`: displays the top todo.
+
+`do [n]`, `top [n]`: move the nth todo to the top.
+
+`unsort [n]`: unsort the nth todo and place it at the bottom.

data/lib/posto/help.rb

@@ -0,0 +1,54 @@
+module Posto
+  module Help
+    class << self
+      def help_text
+        format(parse(read))
+      end
+
+      def read
+        lines = ::File.read("#{::File.dirname(__FILE__)}/help.md").lines
+        lines.map { |line| line.chomp }.reject(&:empty?).map { |line| line.gsub /(### |`)/, "" }
+      end
+
+      def parse(md_file)
+        md_file.map { |x| x.split(": ") }.inject({}) do |memo, o|
+          memo[:title] = o.first if o.size == 1
+          memo[memo[:title]] ||= {}
+          memo[memo[:title]][o.first]= o.last if o.size == 2
+          memo
+        end
+      end
+
+      def format(hash)
+        hash.delete(:title)
+        hash.map { |title, commands| format_list(commands, title) }.join("\n")
+      end
+
+      def format_list(commands, title)
+        "\n#{title}:\n#{format_commands(commands)}"
+      end
+
+      def format_commands(commands)
+        commands.map do |command, definition|
+          format_command_definition(command, definition)
+        end.join("\n")
+      end
+
+      def format_command_definition(command, definition)
+        aliases = command.split(', ')
+        command = aliases.first
+        aliases = aliases[1..-1]
+        (["#{format_command command}#{definition}"] +
+            aliases.map { |command_alias| format_alias(command_alias, command) }).join("\n")
+      end
+
+      def format_alias(command_alias, alias_for)
+        "#{format_command command_alias}alias for '#{alias_for}'"
+      end
+
+      def format_command(command_alias)
+        ' ' * 3 + command_alias.ljust(15)
+      end
+    end
+  end
+end

data/test/arguments_test.rb

@@ -2,13 +2,6 @@ require 'test_helper'
 require 'posto/arguments'
 
 class ArgumentsTest < MiniTest::Unit::TestCase
-  def test_read_flag
-    assert_equal("blah.md", Posto::Arguments.new(%w(-f blah.md)).read_flag("-f"))
-    assert_equal("blah.md", Posto::Arguments.new(%w(sort -f blah.md)).read_flag("-f"))
-    assert_equal("blah.md", Posto::Arguments.new(%w(done 5 -f blah.md)).read_flag("-f"))
-    assert_equal("blah.md", Posto::Arguments.new(%w(-f blah.md done 5)).read_flag("-f"))
-  end
-
   def test_command
     assert_equal("list", Posto::Arguments.new([]).command)
     assert_equal("sort", Posto::Arguments.new(%w(sort)).command)
@@ -20,10 +13,4 @@ class ArgumentsTest < MiniTest::Unit::TestCase
     assert_equal([], Posto::Arguments.new(%w(sort)).params)
     assert_equal(["5"], Posto::Arguments.new(%w(done 5)).params)
   end
-
-  def test_flag_deletes_flag
-    args = %w(-f blah.md done 5)
-    Posto::Arguments.new(args).read_flag("-f")
-    assert_equal(%w(done 5), args)
-  end
 end

data/test/help_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'posto/help'
+
+class HelpTest < MiniTest::Unit::TestCase
+  def test_command_without_aliases
+    assert_equal "   init           create a 'posto.md' file in the working directory.",
+                 Posto::Help.format_command_definition("init", "create a 'posto.md' file in the working directory.")
+  end
+
+  def test_command_with_aliases
+    expected = <<EOF.chomp
+   list           display the todo list.
+   todos          alias for 'list'
+   [default]      alias for 'list'
+EOF
+    assert_equal expected, Posto::Help.format_command_definition("list, todos, [default]", "display the todo list.")
+  end
+
+  def test_help
+    help_text = <<EOF.chomp
+
+List Commands:
+   init           create a 'posto.md' file in the working directory.
+   list           display the todo list.
+   todos          alias for 'list'
+   [default]      alias for 'list'
+   sort           ask the user about priorities to sort todos.
+   resort         reset sort order and sort again (can be time consuming).
+
+Single Todo Commands:
+   add '<todo>'   add <todo> unsorted to the bottom of the todo list.
+   start '<todo>' add, sort and commit with a message based on <todo>.
+   done [n = 1]   remove the nth todo from the list.
+   delete [n]     alias for 'done [n = 1]'
+   commit [n]     remove the nth todo; commit with a message based on the todo.
+   do             displays the top todo.
+   top            alias for 'do'
+   do [n]         move the nth todo to the top.
+   top [n]        alias for 'do [n]'
+   unsort [n]     unsort the nth todo and place it at the bottom.
+EOF
+    assert_equal(help_text, Posto::Help.help_text)
+  end
+end
+
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posto
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,8 +57,10 @@ files:
 - lib/posto/monkeypatch_array.rb
 - lib/posto/application.rb
 - lib/posto/list.rb
+- lib/posto/help.rb
 - lib/posto/todo.rb
 - lib/posto/file.rb
+- lib/posto/help.md
 - lib/posto/arguments.rb
 - lib/posto/human_comparison.rb
 - lib/posto.rb
@@ -68,6 +70,7 @@ files:
 - test/application_test.rb
 - test/monkeypatch_array_test.rb
 - test/todo_test.rb
+- test/help_test.rb
 homepage: http://github.com/mattraibert/posto
 licenses:
 - GPLv3
@@ -83,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3530876056305707581
+      hash: 3524327587989594064
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -103,3 +106,4 @@ test_files:
 - test/application_test.rb
 - test/monkeypatch_array_test.rb
 - test/todo_test.rb
+- test/help_test.rb