tps_reporter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d21f4bd77a71d9c987856ac5f0f584704749296a
-  data.tar.gz: cc243b6990b860aa4c8891ab2394a88e02bd6eff
+  metadata.gz: 6ca34432146f58fced0ce7797a8ee1a50a842c3b
+  data.tar.gz: 78b442712fd0a2d687586d174c82cc758f4bbec8
 SHA512:
-  metadata.gz: 7b773a7577899cb5e6fb9441e4d7820f7390306a4d0de6f7491ec3481184b31d37bfa7363dd5142c577f7f6b1b69136c4ecfa0648854e470d5cc271ff17f1990
-  data.tar.gz: 7691a2a6ef3f16dfe6fafe767c45535d638056b060bae90edb6c0258ad9924dd56a360b853e21fad62729d106f57735459dcf357caf52f1c89b4c8bc47e547fb
+  metadata.gz: 699b6087e62fe5e154f5797bee9cd349580a774a0ea27cccd90d0cc56eff15e4842378d6115a64a0325720ddb51e16d08cc20f817e30c1aacbe906537be37113
+  data.tar.gz: 49dfb6eaf9fe7dff6540dc5371ff7ee4bf69a268f71fcceb738095f5327394d1ffb992793fd3610dd5ba4e17c6c01fa4150c3c28eb17665cd36fb25545cbc030

data/GUIDE.md

@@ -11,26 +11,25 @@ List down the sprints.
 
 Then simply add the sprint ID to your tasks.
 
-    # tasks.yml
+    # tasks.taskpaper
     Sprints:
       s1: Sprint 1 (Nov 1-15)
       s2: Sprint 2 (Nov 16-30)
       s3: Sprint 3 (Dec 1-15)
 
     Beta release:
-      Account:
-        Login: [s1]
-        Logout: [s1, done]
-        Signup: [s2]
+      - Account
+        - Login @s1
+        - Logout @s1 @done
+        - Signup @s2
 
 It's also recursive--you can put sprints in your parent tasks under `_`:
 
     Beta release:
-      Blog:
-        _: [s3]
-        Create posts:
-        Read posts:
-        Delete posts:
+      - Blog @s3
+        - Create posts
+        - Read posts
+        - Delete posts
 
 Trello card linking support
 ---------------------------
@@ -40,8 +39,8 @@ the short URL ID for the Trello card. You can see the short ID in Trello by
 clicking "more..." inside the card popup.
 
     Beta release:
-      Blog: [tr/Xh3pAGp1]
-      Account management:
+      - Blog @tr/Xh3pAGp1
+      - Account management
 
 You can also link the card numbers, but you have to define the main Trello board 
 URL. Simply add `Trello URL: ____` to the top of the file.

data/HISTORY.md

@@ -1,3 +1,8 @@
+v0.4.0 - June 13, 2013
+----------------------
+
+  * TaskPaper support! Tasks are now stored in `tasks.taskpaper` by default.
+
 v0.3.0 - June 13, 2013
 ----------------------
 

data/README.md

@@ -14,7 +14,7 @@ Install TPS (Ruby):
     $ gem install tps_reporter
 
 ...then generate a sample file. (or create `tasks.yml` based on [this sample
-file.][s])
+file.][sample])
 
     $ tps sample
 
@@ -22,52 +22,48 @@ Edit it, then generate the report:
 
     $ tps open
 
-[s]: https://github.com/rstacruz/tps_reporter/blob/master/data/sample.yml
+[sample]: https://github.com/rstacruz/tps_reporter/blob/master/data/sample.taskpaper
 
 Format
 ------
 
-The tasks file, usually `tasks.yml`, is in YAML format.
+The tasks file, usually `tasks.taskpaper`, is in [TaskPaper] format. 
 
-Tasks are always keys (ie, they all end in `:`). They can be nested as far
-as you like.
+They're simply a hierarchy of projects and tasks.
 
 ``` yaml
 Edit users:
-  Register and signup:
-  Login and logout:
+  - Register and signup
+  - Login and logout
 ```
 
-To define task metadata for *leaf* tasks, add it as an array inside the task:
+You can tag some projects or tasks.
 
 ``` yaml
-Manage employees: [done]
-```
-
-Or for *branch* tasks, add it under the `_` task:
+Facebook connect:
+  - Register via Facebook @done
+  - Capture email
 
-``` yaml
-Manage employees:
-  _: [done]
-  Creating employees:
-  Editing employees:
+Manage employees: @done
+  - Create user
+  - Edit user
 ```
 
-The metadata is just a simple YAML array that you can conveniently define using
-`[tag1, tag2, etc]`.  Allowed metadata are:
+The following tags are recognized:
 
- - `done`
- - `in progress`
- - `pt/2839478` *(Pivotal tracker ID. Links to a Pivotal tracker story.)*
- - `tr/LabxGP3` *(Trello card short name. Links to a Trello card.)*
- - `0pt` *(points; influences percentage. needs to end in __pt__ or __pts__.)*
- - `10%` *(task progress. implies __in progress__.)*
+ - `@done`
+ - `@in_progress`
+ - `@pt/2839478` *(Pivotal tracker ID. Links to a Pivotal tracker story.)*
+ - `@tr/LabxGP3` *(Trello card short name. Links to a Trello card.)*
+ - `@0pt` *(points; influences percentage. needs to end in __pt__ or __pts__.)*
+ - `@10%` *(task progress. implies __in progress__.)*
 
 Example:
 
 ``` yaml
-  Creating employees: [40%]
-  Editing employees: [done, 2pts]
+Employee management:
+  - Creating employees @40%
+  - Editing employees @done @2pts
 ```
 
 Exporting to PDF or image
@@ -86,3 +82,39 @@ looks like this:
 ![Comamnd line reporter][cli]
 
 [cli]: https://img.skitch.com/20120204-ccb2guerhrjmj3rht3e4ies4ur.png
+
+Sprints
+-------
+
+You can define sprints to help you see the workload of each sprint. First, 
+define your sprints on top of your file like so (this is a TaskPaper project 
+with notes):
+
+``` yaml
+Sprints:
+  s1: Sprint 1 (May 1)
+  s2: Sprint 2 (May 8)
+  s3: Sprint 3 (May 15)
+```
+
+The names are all arbitrary; `s1`..`s3` is just used here for convention; feel
+free to use any string you like. (say, `week1`..`week7` works well for some
+projects.)
+
+Then use the names as tags (in this case, `@s1`, `@s2`):
+
+``` yaml
+Blog:
+  - Writing articles @s1
+  - Publishing @s2
+```
+
+
+Old YAML syntax
+---------------
+
+The old (v0.3.0) YAML syntax is still supported, see the [v0.3.0 readme] for 
+more info.
+
+[v0.3.0 readme]: http://github.com/rstacruz/tps_reporter/blob/v0.3.0/README.md
+[TaskPaper]: http://www.hogbaysoftware.com/products/taskpaper

data/bin/tps

@@ -62,7 +62,7 @@ module TPS::Command
       exit 130
     end
 
-    FileUtils.cp TPS.root('data', 'sample.yml'), fn
+    FileUtils.cp TPS.root('data', 'sample.taskpaper'), fn
     info "Created '#{fn}'."
     info "Edit it, then use `tps html` to generate HTML from it."
   end
@@ -102,8 +102,8 @@ private
   def tasks_filename
     ARGV.extract('-f') ||
     ENV['TPS_FILE'] ||
-    Dir['./{Tasksfile,tasks.yml}'].first ||
-    "tasks.yml"
+    Dir['./{Tasksfile,tasks.yml,tasks.taskpaper}'].first ||
+    "tasks.taskpaper"
   end
 
   def output(&blk)
@@ -122,7 +122,11 @@ private
     end
 
     begin
-      TPS::TaskList.new yaml: fn
+      if fn.match(/\.taskpaper/)
+        TPS::TaskList.new taskpaper: fn
+      else
+        TPS::TaskList.new yaml: fn
+      end
     rescue Psych::SyntaxError => e
       err "Parse error: #{e.message}"
       exit 256

data/data/sample.taskpaper

@@ -0,0 +1,25 @@
+Version 1:
+
+	This file is in TaskPaper format.
+	Tabs are used to indent.
+	Each task begins with a "- ".
+	Projects end with a ":".
+	Tags are in the format "@tag_name".
+	All other lines (such as these) are considered as notes,
+	and are to be ignored.
+
+	- User signup
+		- Register for an account
+		- Log in @done
+		- Forget password
+
+	- Manage users @in_progress
+		- Create users @in_progress
+		- Delete users
+		- User profile page
+
+	- Blog
+		- Creating new posts @done
+		- Comments @done
+		- Moderating comments @done
+

data/lib/tps.rb

@@ -26,7 +26,9 @@ module TPS
   autoload :TaskList,     'tps/task_list'
   autoload :CliReporter,  'tps/cli_reporter'
   autoload :Sprint,       'tps/sprint'
+  autoload :TaskPaper,    'tps/taskpaper'
   autoload :BarFormatter, 'tps/bar_formatter'
+  autoload :TaskPaperShim, 'tps/taskpaper_shim'
 
   require 'tps/version'
 

data/lib/tps/task_list.rb

@@ -10,6 +10,8 @@ module TPS
 
       data = if options[:yaml]
                YAML::load_file options[:yaml]
+             elsif options[:taskpaper]
+               TaskPaperShim.load options[:taskpaper]
              elsif options[:data]
                options[:data]
              else

data/lib/tps/taskpaper.rb

@@ -0,0 +1,171 @@
+# TaskPaper parser
+#
+#     node = TaskPaper.parse("Project:\n\t- Hello\n\t- Hi")
+#
+#     node.children   #=> Array of <Node>
+#     node.level      #=> 1 (depth)
+#
+#     node.text          #=> 'do things @done'
+#     node.plain_text    #=> 'do things'
+#     node.tags          #=> ['@done']
+#
+#     node.node_type
+#     node.project?
+#     node.task?
+#     node.note?
+#
+module TPS::TaskPaper
+  class Node
+    attr_accessor :level
+    attr_accessor :node_type
+    attr_accessor :text
+    attr_reader :children
+    attr_reader :parent
+
+    DEFAULTS = {
+      :level => 0,
+      :node_type => :root,
+      :text => ''
+    }
+
+    def initialize(options)
+      options = DEFAULTS.merge(options)
+      options.each { |k, v| instance_variable_set :"@#{k}", v }
+      @children = options[:children].map { |data| Node.new data.merge(:parent => self) }
+    end
+
+    def project?
+      node_type == :project
+    end
+
+    def task?
+      node_type == :task
+    end
+
+    def note?
+      node_type == :note
+    end
+
+    def root?
+      level == 0
+    end
+
+    def parent?
+      !! parent
+    end
+
+    def breadcrumbs
+      (parent? ? parent.breadcrumbs : []) + [self]
+    end
+
+    TAG_REGEX = %r[(?:^|\s*)@[^\s]*(?:\([^\)]*\))?]
+
+    # Returns text without tags
+    def plain_text
+      text
+        .gsub(TAG_REGEX, '')
+        .gsub(/\s*:\s*$/, '')
+        .strip
+    end
+
+    def tags
+      text.scan(TAG_REGEX).map(&:strip)
+    end
+
+    def description
+      if children.length > 0
+        first_child = children[0]
+        return first_child.text  if first_child.note?
+      end
+    end
+
+    # Returns a TaskPaper document.
+    def to_s
+      indent = root? ? "" : "\t"
+      lines = ""
+      lines << to_line_s + "\n"  unless root?
+      children.each { |node| lines << node.to_s.gsub(/^/, indent) }
+      lines
+    end
+
+    def to_line_s
+      if project?
+        "#{text}:"
+      elsif task?
+        "- #{text}"
+      else
+        "#{text}"
+      end
+    end
+
+    # Returns a hash from a line
+    #
+    #     parse_line("\t- Hello")
+    #     #=> { node_type: :task, level: 2, text: "Hello" }
+    #
+    def self.parse_line(line)
+      node = {}
+
+      node[:level] = line.match(/^(\t*)/) && ($1.length + 1)
+
+      line = line.strip
+      if line =~ /^\- +(.*)$/
+        node[:node_type] = :task
+        node[:text] = $1
+      elsif line =~ /^(.*):((?:\s*#{TAG_REGEX})+)?$/m
+        node[:node_type] = :project
+        node[:text] = "#{$1}#{$2}"
+      else
+        node[:node_type] = :note
+        node[:text] = line
+      end
+
+      node[:children] = Array.new
+      node
+    end
+
+    def walk(&blk)
+      results = []
+      results << self  if yield(self)
+      children.each { |node| results += node.walk(&blk) }
+      results
+    end
+  end
+
+  # Parses a string into a node tree.
+  # Returns a node.
+  #
+  #     node = TaskPaper.parse("Project:\n\t- Hello\n\t- Hi")
+  #
+  def self.parse(string)
+    lines = string.split("\n")
+
+    root = { :node_type => :root, :level => 0, :children => [] }
+    ancestry = [root]
+    level = 0
+
+    lines.each_with_index do |line, i|
+      next  if line.strip == ""
+
+      node = Node.parse_line(line)
+
+      if node[:level] <= level  # Sibling
+        ancestry[node[:level]-1][:children] << node
+      elsif node[:level] == level + 1  # Child
+        ancestry[level][:children] << node
+        ancestry[level+1] = node
+      else
+        raise "Line #{i}: indentation mismatch (#{node[:level]} tabs found, expected 0..#{level+1})"
+      end
+
+      level = node[:level]
+      ancestry[level] = node
+    end
+
+    Node.new(root)
+  end
+
+  def self.load_file(file)
+    parse File.read(file)
+  end
+end

data/lib/tps/taskpaper_shim.rb

@@ -0,0 +1,66 @@
+# Converts a TaskPaper document to the internal format (as represented by
+# YAML).
+#
+#     hash = TaskPaperShim.load('file.taskpaper')
+#     hash = TaskPaperShim.parse("Version 1:\n\t- Login")
+#
+module TPS::TaskPaperShim
+  extend self
+
+  SETTINGS = ['Trello URL']
+
+  def parse(source)
+    node = TPS::TaskPaper.parse(source)
+
+    hash = work(node)
+    hash
+  end
+
+  def work(node)
+    return nil if node.tags.empty? && node.children.empty?
+    hash = {}
+
+    # Load tags
+    tags = node.tags.map { |s| s.gsub(/^@/, '').gsub(/_/, ' ') }
+    if tags.any?
+      if node.children.any?
+        hash['_'] = tags
+      else
+        return tags
+      end
+    end
+
+    # Load children
+    node.children.each do |child|
+      text = child.plain_text
+
+      # For "Trello URL: xxx" settings
+      if is_setting?(child)
+        child.plain_text =~ /^(.*?): (.*)$/
+        hash[$1] = $2
+
+      # For "s1: Sprint 1" notes
+      elsif node.plain_text == "Sprints"
+        text.match(/^(.*?): (.*)$/) && hash[$1] = $2
+
+      # For everything else
+      elsif !child.note?
+        hash[text] = work(child)
+      end
+    end
+
+    hash
+  end
+
+  # Checks if a given node is a settings node
+  def is_setting?(node)
+    if node.note?
+      SETTINGS.any? { |tag| node.plain_text =~ /^#{tag}:/ }
+    end
+  end
+
+  def load(file)
+    data = File.read(file)
+    parse data
+  end
+end

data/lib/tps/version.rb

@@ -1,5 +1,5 @@
 module TPS
   def self.version
-    "0.3.0"
+    "0.4.0"
   end
 end

data/tasks.taskpaper

@@ -0,0 +1,23 @@
+Sprints:
+	s1: Sprint 1 (November)
+	s2: Sprint 2 (Jan)
+	s3: Sprint 3 (December)
+
+Version 1:
+	This is a note. It will be ignored.
+
+	User signup: @s1
+		- Register for an account
+		- Log in @done
+		- Forget password
+
+	- Manage users @in_progress @s1
+		- Create users @in_progress @s3
+		- Delete users
+		- User profile page
+
+	- Blog
+		- Creating new posts @done
+		- Comments @done
+		- Moderating comments
+

data/test/fixtures/hello.taskpaper

@@ -0,0 +1,48 @@
+Milestone 1:
+	- First task @25%
+
+	User login:
+		- Login
+		- Signup
+
+	Overridden percent: @50%
+		- one @done
+		- two @done
+		- three @done
+
+	Explicit points: @15pt
+		- one @done
+		- two @done
+		- three @done
+		- four
+
+	Compound points:
+		- one
+		- two
+		three:
+			- sub1 @3pts @done
+			- sub2
+
+	Point rescaling:
+		Has 6 sub points, but will be rescaled to 8.
+		That is, the done "3" point task is actually worth 4 points.
+
+		one: @8pts
+			- sub1 @3pts @done
+			- sub2 @1pt
+			- sub3 @1pt
+			- sub4 @1pt
+
+	In progress:
+		- one
+		- two @in_progress
+
+	Progress override: @50%
+		#7
+		It's supposed to be 50% done because of it's subtasks, but
+		Defining our own percentage overrides that.
+
+		- one @done
+		- two
+
+Milestone 2:

data/test/settings_test.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class SettingsTest < UnitTest
+  setup do
+    @hash = TPS::TaskPaperShim.parse("Trello URL: http://xyz\nVersion 1:\n\t- Hello")
+  end
+
+  test "use setting" do
+    assert_equal "http://xyz", @hash["Trello URL"]
+  end
+end

data/test/taskpaper_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TaskpaperTest < UnitTest
+  test "parseable" do
+    data = File.read('tasks.taskpaper')
+    root = TPS::TaskPaper.parse(data)
+  end
+
+  describe "basic doc" do
+    setup do
+      @source = "Version 1:\n\t- Log in @done"
+      @node = TPS::TaskPaper.parse(@source)
+    end
+
+    test "should work" do
+      assert_equal @node.to_s.strip, @source
+    end
+  end
+
+  describe "shim" do
+    setup do
+      @hash = TPS::TaskPaperShim.load('tasks.taskpaper')
+    end
+
+    test "should work" do
+      expected = {"Sprints"=>{"s1"=>"Sprint 1 (November)", "s2"=>"Sprint 2 (Jan)", "s3"=>"Sprint 3 (December)"}, "Version 1"=>{"User signup"=>{"_"=>["s1"], "Register for an account"=>nil, "Log in"=>["done"], "Forget password"=>nil}, "Manage users"=>{"_"=>["in progress", "s1"], "Create users"=>["in progress", "s3"], "Delete users"=>nil, "User profile page"=>nil}, "Blog"=>{"Creating new posts"=>["done"], "Comments"=>["done"], "Moderating comments"=>["done"]}}}
+      assert_equal expected, @hash
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tps_reporter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rico Sta. Cruz
@@ -54,7 +54,7 @@ files:
 - Rakefile
 - bin/tps
 - data/index.haml
-- data/sample.yml
+- data/sample.taskpaper
 - lib/tps.rb
 - lib/tps/bar_formatter.rb
 - lib/tps/cli_reporter.rb
@@ -62,8 +62,12 @@ files:
 - lib/tps/sprint.rb
 - lib/tps/task.rb
 - lib/tps/task_list.rb
+- lib/tps/taskpaper.rb
+- lib/tps/taskpaper_shim.rb
 - lib/tps/version.rb
+- tasks.taskpaper
 - test/bar_test.rb
+- test/fixtures/hello.taskpaper
 - test/fixtures/hello.yml
 - test/fixtures/markers.yml
 - test/fixtures/multi_sprints.yml
@@ -71,8 +75,10 @@ files:
 - test/fixtures/sprints.yml
 - test/html_test.rb
 - test/multi_sprints_test.rb
+- test/settings_test.rb
 - test/sprint_points_test.rb
 - test/sprint_test.rb
+- test/taskpaper_test.rb
 - test/test_helper.rb
 - test/tps_test.rb
 - tps_reporter.gemspec

data/data/sample.yml

@@ -1,18 +0,0 @@
-Version 1:
-
-  User signup:
-    Register for an account:
-    Log in: [done]
-    Forget password:
-
-  Manage users:
-    _: [in progress]
-    Create users: [in progress]
-    Delete users:
-    User profile page:
-
-  Blog:
-    Creating new posts: [done]
-    Comments: [done]
-    Moderating comments: [done]
-