mastodon2 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE.md

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+doc
+.yardoc

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Colin Shea
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.**

data/README.md

@@ -0,0 +1,34 @@
+# Mastodon
+A [todo.txt][ttxt] parser.
+
+[ttxt]: http://ginatrapani.github.com/todo.txt-cli/
+
+## Installation
+
+    sudo gem install mastodon
+
+## Usage
+
+    require 'mastodon'
+    mast = Mastodon.new(File.readlines("todo.txt"))
+    # List all the projects
+    mast.projects
+    # List all the contexts
+    mast.contexts
+
+
+## See Also
+There are other links you can take a look at. If you care to, that is.
+
+ * [Run Code Run][rcr] (continuous integration)
+ * [Caliper & metric\_fu report][calip]
+ * [RDoc.info Documentation][rdoci] ([yardoc.org][yardoc])
+
+[rcr]: http://runcoderun.com/evaryont/mastodon
+[calip]: http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fevaryont%2Fmastodon.git
+[rdoci]: http://rdoc.info/projects/evaryont/mastodon
+[yardoc]: http://yardoc.org/docs/evaryont-mastodon
+
+## Copyright
+Mastodon is released under the MIT license. Copyright (C) Colin Shea 2009. For
+more information, consult LICENSE.txt for more information.

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'rake'
+
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mastodon2"
+    gem.summary = %Q{A Ruby parser for todo.txt files}
+    gem.description = %Q{A Ruby parser for todo.txt files}
+    gem.email = "colin@evaryont.me"
+    gem.homepage = "http://evaryont.me"
+    gem.authors = ["Colin Shea"]
+    gem.add_development_dependency "riot", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+task :test => :check_dependencies
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ["lib/**/*.rb"]
+  end
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+namespace :release do
+    desc "Release to all locations: Git, GitHub and GemCutter"
+    task :all => ["git:release", "github:release", "gemcutter:release"]
+end

data/VERSION.yml

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

data/lib/core_ext/string/pull_regex.rb

@@ -0,0 +1,15 @@
+class String
+    # Given 'string', find all matches of regular expression (removed from
+    # +string+) and return them as an array of strings.
+    def pull_regex(regexp)
+        found_values = []
+
+        until ((value = self[regexp]).nil?)
+            vindex = index(value)
+            self[ vindex .. (vindex + value.length) ] = ""
+            found_values << value.match(regexp)[1]
+        end
+
+        return found_values
+    end
+end

data/lib/mastodon.rb

@@ -0,0 +1,76 @@
+require 'set'
+
+require 'core_ext/string/pull_regex'
+
+require 'mastodon/todo'
+
+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)
+        @contexts = Set.new
+        @projects = Set.new
+        @todos = []
+
+        parse! todos.map{|line| line.strip}
+
+        @contexts = @contexts.to_a
+        @projects = @projects.to_a
+    end
+
+    def parse!(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 = nil
+
+            current_contexts = todo.pull_regex(Context_Regex)
+            unless current_contexts.empty?
+                @contexts.merge(current_contexts)
+            end
+
+            current_projects = todo.pull_regex(Project_Regex)
+            unless current_projects.empty?
+                @projects.merge(current_projects)
+            end
+
+            current_priority = todo.pull_regex(Priority_Regex)
+
+            todo.strip!
+            @todos << Mastodon::Todo.new(todo, current_contexts, current_projects, current_priority.first)
+        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,30 @@
+class Mastodon
+    class Todo < Struct.new(:text, :contexts, :projects, :priority)
+        include Comparable
+
+        def to_s
+            pri = priority ? "(#{priority})" : ""
+            ctx = contexts.empty? ? "" : "@#{contexts.join(' @')}"
+            prj = projects.empty? ? "" : "+#{projects.join(' +')}"
+
+            "#{pri} #{text} #{ctx} #{prj}".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/mastodon.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mastodon}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Colin Shea"]
+  s.date = %q{2009-12-23}
+  s.description = %q{Mastodon: A ruby parser for todo.txt files.
+
+And the mastodon, like plain text, isn't extinct! (Yet.)}
+  s.email = %q{colin@evaryont.me}
+  s.extra_rdoc_files = [
+    "README.mkd"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://github.com/evaryont/mastodon/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A ruby parser for todo.txt files}
+  s.test_files = [
+    "test/run_tests.rb",
+     "test/test_helper.rb",
+     "test/test_mastodon.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/mastodon_test.rb

@@ -0,0 +1,139 @@
+require 'teststrap'
+
+context "Mastodon" do
+    setup do
+        @todos = File.readlines(File.join(File.dirname(__FILE__), "todo.txt"))
+        Mastodon.new(@todos)
+    end
+
+    context "Projects" do
+        setup do
+            topic.projects
+        end
+
+        asserts_topic.equals  ["proj", "proj2", "proj+phone", "proj/foo", "p_r_o_j", "p-r-o-j", "+proj", "@proj"]
+
+        asserts_topic.kind_of? Array
+    end
+
+    context "Contexts" do
+        setup do
+            topic.contexts
+        end
+
+        asserts_topic.equals ["con", "con2", "con@phone", "con/foo", "c_o_n", "c-o-n", "@con", "+con"]
+
+        asserts_topic.kind_of? Array
+    end
+
+    asserts "Non-existent contexts should return an empty array" do
+        topic.find_context("nosuchthing") == []
+    end
+    asserts "Non-existent projects should return an empty array" do
+        topic.find_project("thisprojectdoesntexist") == []
+    end
+
+    context "Context #2" do
+        setup do
+            topic.find_context("con2")
+        end
+        asserts "Context size should be greater than zero" do
+            topic.size > 0
+        end
+        asserts "First todo with the context 'con2' should be 'Multiple contexts'" do
+            topic.first.text == "Multiple contexts"
+        end
+    end
+
+    context "Project #2" do
+        setup do
+            topic.find_project("proj2")
+        end
+        should "greater than zero" do
+            topic.size > 0
+        end
+        asserts "First todo with the project 'proj2' should be 'Multiple projects'" do
+            topic.first.text == "Multiple projects"
+        end
+    end
+
+    context "Todo" do
+#asserts(:size).equals @todos.size
+
+        asserts "all todos are of type Mastodon::Todo" do
+            !(topic.todos.map do |todo|
+                todo.is_a? Mastodon::Todo
+            end.index(false))
+        end
+
+        context "Lossless parsing: 1st Todo: Normal example" do
+            setup do
+                @todo = @todos[0].strip
+                topic[0]
+            end
+
+            should "be the same characters" do
+                topic.to_s.chars.to_a == @todo.chars.to_a
+            end
+            should "be the same length" do
+                topic.to_s.length == @todo.length
+            end
+        end
+
+        context "Lossless parsing: 8th Todo: Normal example, with priority" do
+            setup do
+                @todo = @todos[7].strip
+                topic[7]
+            end
+
+            should "be the same characters" do
+                topic.to_s.chars.to_a == @todo.chars.to_a
+            end
+            should "be the same length" do
+                topic.to_s.length == @todo.length
+            end
+        end
+
+        context "Lossless parsing: 17th Todo: Example without any metadata" do
+            setup do
+                @todo = @todos[16].strip
+                topic[16]
+            end
+
+            should "be the same characters" do
+                topic.to_s.chars.to_a == @todo.chars.to_a
+            end
+            should "be the same length" do
+                topic.to_s.length == @todo.length
+            end
+        end
+    end
+
+    asserts "13th todo should have the context 'con'" do
+        topic[13].contexts = ["con"]
+    end
+    asserts "14th todo should have the project 'proj'" do
+        topic[14].projects = ["proj"]
+    end
+
+    context "Priority" do
+        asserts "3rd todo should have no priority" do
+            topic[3].priority.nil?
+        end
+        asserts "4th todo should have no priority" do
+            topic[4].priority.nil?
+        end
+        asserts "5th todo should have priority A" do
+            topic[5].priority = "A"
+        end
+        asserts "6th todo should have priority Z" do
+            topic[6].priority = "Z"
+        end
+        asserts "7th todo should have priority Q" do
+            topic[7].priority = "Q"
+        end
+        asserts "8th todo should have no priority" do
+            topic[8].priority.nil?
+        end
+    end
+end

data/test/teststrap.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'riot'
+require 'mastodon'
+require 'pp'

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,88 @@
+--- !ruby/object:Gem::Specification 
+name: mastodon2
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Colin Shea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-29 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Ruby parser for todo.txt files
+email: colin@evaryont.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.yml
+- lib/core_ext/string/pull_regex.rb
+- lib/mastodon.rb
+- lib/mastodon/todo.rb
+- mastodon.gemspec
+- test/mastodon_test.rb
+- test/teststrap.rb
+- test/todo.txt
+has_rdoc: true
+homepage: http://evaryont.me
+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/mastodon_test.rb
+- test/teststrap.rb