mastodon 0.1.0

data/README.mkd

@@ -0,0 +1,9 @@
+# Mastodon
+
+A todo.txt[1] parser.
+
+[1]: http://ginatrapani.github.com/todo.txt-cli/
+
+## Installation
+
+    sudo gem install mastodon

data/Rakefile

@@ -0,0 +1,55 @@
+begin
+  require 'jeweler'
+rescue LoadError
+  puts "Jeweler not available, but is required. Install it with: sudo gem install jeweler"
+  exit 1
+end
+
+@jtasks = Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "mastodon"
+  gemspec.summary = "A ruby parser for todo.txt files"
+  gemspec.description = "Mastodon: A ruby parser for todo.txt files.\n\nAnd the mastodon, like plain text, isn't extinct! (Yet.)"
+  gemspec.email = "colin@evaryont.me"
+  gemspec.homepage = "http://github.com/evaryont/mastodon/"
+  gemspec.authors = ["Colin Shea"]
+end
+Jeweler::GemcutterTasks.new
+@jeweler = @jtasks.jeweler
+
+namespace :version do
+    desc "DON'T CALL. Write the version to lib/#{@jeweler.gemspec_helper.spec.name}/version.rb"
+    task :ruby do
+        # TODO: This is hard coded but it should be dynamic, given
+        # the gem spec
+        file = File.open("lib/#{@jeweler.gemspec_helper.spec.name}/version.rb", "w")
+        # TODO: and so should this class template
+        file.write <<-CLASS
+# Automatically generated by `rake version:ruby' - use version:bump to change
+# this, do not edit this directly, as it will be overwritten!
+class #{@jeweler.gemspec_helper.spec.name.capitalize}
+    VERSION = [#{@jeweler.major_version}, #{@jeweler.minor_version}, #{@jeweler.patch_version}]
+end
+CLASS
+        system("git commit --file='.git/COMMIT_EDITMSG' --amend -q -o 'lib/#{@jeweler.gemspec_helper.spec.name}/version.rb'")
+    end
+
+    # Take advantage of Rake not overwriting tasks.
+    #
+    # After the 'real' task has been called, write version.rb as well.
+    namespace :bump do
+        task :major do
+            Rake::Task["version:ruby"].execute
+        end
+        task :minor do
+            Rake::Task["version:ruby"].execute
+        end
+        task :patch do
+            Rake::Task["version:ruby"].execute
+        end
+    end
+end
+
+desc "Run the nanotest suite"
+task :test do
+    system("ruby -I'lib:test' test/run_tests.rb")
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0
+:build: 

data/lib/mastodon.rb

@@ -0,0 +1,82 @@
+require 'set'
+require 'pp'
+
+require 'mastodon/todo'
+require 'mastodon/version'
+
+class Mastodon
+    # A context is: An at-sign (@) followed by one or more non-whitespace characters.
+    Context_Regex  = /(?<!\+)\B@(\S+)/
+    # A project is: An plus sign (+) followed by one or more non-whitespace characters.
+    Project_Regex  = /(?<!@)\B\+(\S+)/
+    # A priority is: A capital letter (A-Z) surrounded by parentheses, at the beginning of the line.
+    Priority_Regex = /^\(([A-Z])\)/
+
+    attr_reader :contexts, :projects, :todos
+
+    # +todo+: An array of strings (each being an individual todo item)
+    def initialize(todos)
+        parse! todos.map{|line| line.strip}
+    end
+
+    def parse!(todos)
+        @contexts = Set.new
+        @projects = Set.new
+        @todos = []
+
+        todos.each do |todo|
+            # Looping through the string, find the metadata (context, project,
+            # priority). Store it in a temporary variable, then clear it from
+            # the original string. Strip all remaining whitespace at the end.
+
+            current_contexts = []
+            current_projects = []
+            current_priority, priority = nil, nil
+
+            until ((context = todo[Context_Regex]).nil?)
+                index = todo.index(context)
+                todo[index..(index+context.length)] = ""
+                current_contexts << context.match(Context_Regex)[1]
+                contexts << context.match(Context_Regex)[1]
+            end
+
+            until ((project = todo[Project_Regex]).nil?)
+                index = todo.index(project)
+                todo[index..(index+project.length)] = ""
+                current_projects << project.match(Project_Regex)[1]
+                projects << project.match(Project_Regex)[1]
+            end
+
+            priority = todo[Priority_Regex]
+            unless priority.nil?
+                index = todo.index(priority)
+                todo[index..(index+priority.length)] = ""
+                current_priority = priority.match(Priority_Regex)[1]
+            end
+
+            todo.strip!
+            @todos << Mastodon::Todo.new(todo, current_contexts, current_projects, current_priority)
+        end
+    end
+
+    # How many todos there are.
+    def size
+        @todos.size
+    end
+
+    # Get an individual todo. The id and line number are the same. 0 index, not
+    # 1, as files are numbered. So line 3 is id 2. XXX: Change?
+    def [](id)
+        @todos[id]
+    end
+
+    # Find all todos that have the context @+context+
+    def find_context(context)
+        @todos.select { |todo| todo.contexts.include? context }
+    end
+
+    # Find all todos that have the project ++project+
+    def find_project(project)
+        @todos.select { |todo| todo.projects.include? project }
+    end
+end

data/lib/mastodon/todo.rb

@@ -0,0 +1,27 @@
+class Mastodon
+    class Todo < Struct.new(:text, :contexts, :projects, :priority)
+        include Comparable
+
+        def to_s
+            pri = priority ? "(#{priority})" : ""
+            "#{pri} #{text} @#{contexts.join(' @')} +#{projects.join(' +')}".strip
+        end
+
+        def inspect
+            "#<Mastodon::Todo \"#{to_s}\">"
+        end
+
+        # Comparison operator: Sort todos by their priority first, then sort
+        # them by the text.
+        def <=>(other_todo)
+            return -1 if (priority.nil? and !other_todo.priority.nil?)
+
+            pri = (priority <=> other_todo.priority)
+            if pri == 0
+                return text <=> other_todo.text
+            else
+                return pri
+            end
+        end
+    end
+end

data/lib/mastodon/version.rb

@@ -0,0 +1,5 @@
+# Automatically generated by `rake version:ruby' - use version:bump to change
+# this, do not edit this directly, as it will be overwritten!
+class Mastodon
+    VERSION = [0, 1, 0]
+end

data/test/run_tests.rb

@@ -0,0 +1,2 @@
+require 'test_helper'
+require 'test_mastodon'

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'nanotest'
+
+begin # Optional dependencies
+    require 'nanotest/stats'  # Gets some nice speed stats.
+    require 'redgreen'        # Pretty colors!
+rescue LoadError
+end
+include Nanotest
+
+# Include the library
+require File.dirname(__FILE__) + "/../lib/mastodon.rb"
+
+SAMPLE_TODOS = File.readlines(File.join(File.dirname(__FILE__), "todo.txt")) unless Kernel.const_defined? :SAMPLE_TODOS
+@mast = Mastodon.new(SAMPLE_TODOS)

data/test/test_mastodon.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+# Test searching and caching.
+assert { @mast.projects.to_a == ["proj", "proj2", "proj+phone", "proj/foo", "p_r_o_j", "p-r-o-j", "+proj", "@proj"] }
+assert { @mast.contexts.to_a == ["con", "con2", "con@phone", "con/foo", "c_o_n", "c-o-n", "@con", "+con"] }
+
+# Finding existing items
+assert { @mast.find_context("con2").size  > 0 }
+assert { @mast.find_context("con2").first.text == "Multiple contexts" }
+assert { @mast.find_project("proj2").size > 0 }
+assert { @mast.find_project("proj2").first.text == "Multiple projects" }
+
+# Finding non-existing items
+assert { @mast.find_context("nosuchthing") == [] }
+assert { @mast.find_project("thisprojectdoesntexist") == [] }
+
+# General utility methods.
+assert { @mast.size == SAMPLE_TODOS.size }
+# While I can't guarantee a 1:1 match, nothing should be lost. Just possibly rearranged.
+assert { (@mast[0].to_s.chars.to_a == SAMPLE_TODOS[0].strip.chars.to_a) and (@mast[0].to_s.length == SAMPLE_TODOS[0].strip.length) }
+
+# Test if correct classes are returned
+assert { @mast.projects.is_a? Set }
+assert { @mast.contexts.is_a? Set }
+assert { @mast[0].is_a? Mastodon::Todo }
+
+# Test if matching at the beginning of a line works
+assert { @mast[13].contexts = ["con"] }
+assert { @mast[14].projects = ["proj"] }
+
+# Test priority detection
+assert { @mast[3].priority.nil?  }
+assert { @mast[4].priority.nil?  }
+assert { @mast[5].priority = "A" }
+assert { @mast[6].priority = "Z" }
+assert { @mast[7].priority = "Q" }
+assert { @mast[8].priority.nil?  }

data/test/todo.txt

@@ -0,0 +1,17 @@
+Todo @con +proj
+left @ right @con
+user@server email
+Multiple projects +proj +proj2
+Multiple contexts @con @con2
+(A) Priority
+(Z) All the way to Z
+(Q) All mixed together @con +proj
+Not a priority: (A)
+Advanced contexts @con@phone @con/foo @c_o_n @c-o-n @@con
+Advanced projects +proj+phone +proj/foo +p_r_o_j +p-r-o-j ++proj
+Mixed symbols: +@proj @+con
+@con Leading with a context
++proj Leading with a project
+Google+Yahoo+Microsoft == monopoly
+Google + Yahoo + Microsoft == monopoly
+Ready to (ab)use

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: mastodon
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Colin Shea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-23 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Mastodon: A ruby parser for todo.txt files.
+  
+  And the mastodon, like plain text, isn't extinct! (Yet.)
+email: colin@evaryont.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mkd
+files: 
+- Rakefile
+- VERSION.yml
+- lib/mastodon.rb
+- lib/mastodon/todo.rb
+- lib/mastodon/version.rb
+- test/run_tests.rb
+- test/test_helper.rb
+- test/test_mastodon.rb
+- test/todo.txt
+- README.mkd
+has_rdoc: true
+homepage: http://github.com/evaryont/mastodon/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby parser for todo.txt files
+test_files: 
+- test/run_tests.rb
+- test/test_helper.rb
+- test/test_mastodon.rb