mastodon 0.1.0 → 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

@@ -1,55 +1,83 @@
+require 'rubygems'
+require 'rake'
+
+task :default => :test
+
 begin
   require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mastodon"
+    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
-  puts "Jeweler not available, but is required. Install it with: sudo gem install jeweler"
-  exit 1
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
 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"]
+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
-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}]
+
+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
-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
+
+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
 
-desc "Run the nanotest suite"
-task :test do
-    system("ruby -I'lib:test' test/run_tests.rb")
+namespace :release do
+    desc "Release to all locations: Git, GitHub and GemCutter"
+    task :all => ["git:release", "github:release", "gemcutter:release"]
 end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 1
-:patch: 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

@@ -1,8 +1,8 @@
 require 'set'
-require 'pp'
+
+require 'core_ext/string/pull_regex'
 
 require 'mastodon/todo'
-require 'mastodon/version'
 
 class Mastodon
     # A context is: An at-sign (@) followed by one or more non-whitespace characters.
@@ -16,14 +16,17 @@ class Mastodon
 
     # +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 = []
 
+        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
@@ -31,31 +34,22 @@ class Mastodon
 
             current_contexts = []
             current_projects = []
-            current_priority, priority = nil, nil
+            current_priority = 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]
+            current_contexts = todo.pull_regex(Context_Regex)
+            unless current_contexts.empty?
+                @contexts.merge(current_contexts)
             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]
+            current_projects = todo.pull_regex(Project_Regex)
+            unless current_projects.empty?
+                @projects.merge(current_projects)
             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
+            current_priority = todo.pull_regex(Priority_Regex)
 
             todo.strip!
-            @todos << Mastodon::Todo.new(todo, current_contexts, current_projects, current_priority)
+            @todos << Mastodon::Todo.new(todo, current_contexts, current_projects, current_priority.first)
         end
     end
 

data/lib/mastodon/todo.rb

@@ -4,7 +4,10 @@ class Mastodon
 
         def to_s
             pri = priority ? "(#{priority})" : ""
-            "#{pri} #{text} @#{contexts.join(' @')} +#{projects.join(' +')}".strip
+            ctx = contexts.empty? ? "" : "@#{contexts.join(' @')}"
+            prj = projects.empty? ? "" : "+#{projects.join(' +')}"
+
+            "#{pri} #{text} #{ctx} #{prj}".strip
         end
 
         def inspect

data/mastodon.gemspec

@@ -0,0 +1,60 @@
+# 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.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Colin Shea"]
+  s.date = %q{2009-12-29}
+  s.description = %q{A Ruby parser for todo.txt files}
+  s.email = %q{colin@evaryont.me}
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+     "README.md"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://evaryont.me}
+  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/mastodon_test.rb",
+     "test/teststrap.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
+      s.add_development_dependency(%q<riot>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<riot>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<riot>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mastodon
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Colin Shea
@@ -9,34 +9,54 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-23 00:00:00 -05:00
+date: 2009-12-29 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.)
+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: 
-- README.mkd
+- 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
-- lib/mastodon/version.rb
-- test/run_tests.rb
-- test/test_helper.rb
-- test/test_mastodon.rb
+- mastodon.gemspec
+- test/mastodon_test.rb
+- test/teststrap.rb
 - test/todo.txt
-- README.mkd
 has_rdoc: true
-homepage: http://github.com/evaryont/mastodon/
+homepage: http://evaryont.me
 licenses: []
 
 post_install_message: 
@@ -62,8 +82,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A ruby parser for todo.txt files
+summary: A Ruby parser for todo.txt files
 test_files: 
-- test/run_tests.rb
-- test/test_helper.rb
-- test/test_mastodon.rb
+- test/mastodon_test.rb
+- test/teststrap.rb

data/README.mkd

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

data/lib/mastodon/version.rb

@@ -1,5 +0,0 @@
-# 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

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

data/test/test_helper.rb

@@ -1,14 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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?  }