rtodotxt 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21ba6fcc82ae122035a4bd878dba4c5d03602f0b
+  data.tar.gz: 526dc4fe246aedfb54ef95d00a899e33a1ffd5c4
+SHA512:
+  metadata.gz: 1c005c02f8b20f03e8c6190571afffda2e30693f5decf1e31696fdfa3cdcba737d81de48c6a21ec579b86e526bbe72379c11e9cfe63b63baac1b3b5ddd6e0d86
+  data.tar.gz: 5cdb916685eb8568ce469696ba77f1ad5a587324eaa07d4a0cb8892921963b6a740f04396b06cd81b438a4d19c612adef91828344f2245b4d0e72645fe65c5a2

data/.autotest

@@ -0,0 +1,2 @@
+require "autotest/growl"
+require "autotest/fsevent"

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rtodotxt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Philipp Fehre
+
+MIT License
+
+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,19 @@
+Rtodotxt
+========
+Work with [todo.txt](http://todotxt.com/) files from ruby.
+
+Usage
+-----
+Simply work with any todo.txt formatted file
+
+    require 'rtodotxt'
+
+    list = Rtodotxt::List.new(File.read('./todo.txt')) # load list
+    list.first # first todo
+    list.first.done! # mark first todo done
+    list.first.done? # => true
+
+    list.map(&:contexts).flatten.uniq # get all contexts
+    list.map(&:projects).flatten.uniq # get all projects
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rtodotxt.rb

@@ -0,0 +1,99 @@
+require "rtodotxt/version"
+require "date"
+
+module Rtodotxt
+  
+  class List < Array
+    
+    def initialize list
+      super self.class.gen_list_from_string list
+    end
+            
+    # Split a string by each line and generate an array of todos
+    def read str
+      super self.class.gen_list_from_string str
+    end
+    
+    # Join the todo text together to return the list 
+    def print
+      str = self.map { |t| t.text }.join "\n"
+      # the result must end with a newline!
+      str << "\n"
+    end
+    
+    def self.gen_list_from_string str
+      str.split( "\n" ).map! do |line| 
+        Todo.new line unless line.empty?
+      end
+    end
+               
+  end
+  
+  class Todo
+    include Comparable
+    attr_accessor :text
+    
+    def initialize text
+      @text = text
+    end
+    
+    # Compare todos, the order is reversed so that a printed list is in correct 
+    # order
+    def <=> a_todo
+      if done?
+        a_todo.done? ? 0 : 1
+      elsif a_todo.prio.empty? || prio.empty?
+        if a_todo.prio.empty? && prio.empty?
+          0
+        elsif a_todo.prio.empty?
+          -1
+        else
+          1
+        end
+      else
+        prio <=> a_todo.prio
+      end
+    end
+    
+    def done!
+      @text = "x #{Date.today.to_s} " + @text.gsub( /\(.\)\s/, '' ) unless done?
+      # return self to allow method chaining
+      self
+    end
+    
+    def prio! p
+      if p == ""
+        # Remove the priority
+        @text.gsub! /\(.\)\s/, ''
+      elsif p.match /\A.\Z/ 
+        # Single char to be used as priority
+        @text = "(#{p.match(/\A.\Z/)[0].upcase}) #{@text}"
+      else
+        raise ArgumentError, "Illegal priority", caller
+      end
+    end
+    
+    def prio
+      # Match the priority from the string
+      prio = @text.match(/\((.)\)/)
+      prio.nil? ? "" : prio[1]
+    end
+    
+    def done?
+      # if todo text starts with x than it is done
+      @text.match( /\Ax\s/ ).nil? ? false : true
+    end
+    
+    def contexts
+      contexts = @text.scan /@(\S+)/ 
+      contexts.uniq.flatten      
+    end
+    
+    def projects
+      projects = @text.scan /\+(\S+)/
+      projects.uniq.flatten
+    end
+    
+  end
+
+end

data/lib/rtodotxt/version.rb

@@ -0,0 +1,3 @@
+module Rtodotxt
+  VERSION = "0.0.2"
+end

data/rtodotxt.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rtodotxt/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Philipp Fehre"]
+  gem.email         = ["philipp.fehre@googlemail.com"]
+  gem.description   = %q{Working with todo.txt file in ruby}
+  gem.summary       = %q{Use a todotxt formatted file in ruby}
+  gem.homepage      = "http://github.com/sideshowcoder/rtodotxt"
+
+  # Development dependencies
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rtodotxt"
+  gem.require_paths = ["lib"]
+  gem.version       = Rtodotxt::VERSION
+end

data/spec/rtodotxt_spec.rb

@@ -0,0 +1,150 @@
+require "spec_helper"
+
+a_list = "(A) Buy milk @supermarket +groceries
+(C) Fix rtodotxt
+(B) get phil to organize +bbq
+(A) Buy bread @baker +groceries
+Get some coffee +groceries
+"
+
+a_list_sorted = "(A) Buy milk @supermarket +groceries
+(A) Buy bread @baker +groceries
+(B) get phil to organize +bbq
+(C) Fix rtodotxt
+Get some coffee +groceries
+"
+
+b_list = "(C) Fix rtodotxt
+x 2012-03-13 get phil to organize +bbq
+(A) Buy bread @baker +groceries
+x 2012-03-13 Buy milk @supermarket +groceries
+Get some coffee +groceries
+"
+
+b_list_sorted = "(A) Buy bread @baker +groceries
+(C) Fix rtodotxt
+Get some coffee +groceries
+x 2012-03-13 Buy milk @supermarket +groceries
+x 2012-03-13 get phil to organize +bbq
+"
+
+
+a_todo = "Buy milk @supermarket +groceries"
+a_todo_prio = "(A) Buy milk @supermarket +groceries"
+a_todo_done = "x #{Date.today.to_s} Buy milk @supermarket +groceries"
+
+b_todo = "Get some coffee +groceries"
+b_todo_done = "x #{Date.today.to_s} Get some coffee +groceries"
+b_todo_prio = "(A) Get some coffee +groceries"
+
+
+describe Rtodotxt::List do
+  
+  it "should read a string" do
+    tl = Rtodotxt::List.new a_list
+    tl.print.should eql a_list
+  end    
+  
+  it "should generate enumerable todos" do
+    tl = Rtodotxt::List.new a_list
+    tl.each do |t|
+      t.class.should eql Rtodotxt::Todo
+    end
+  end
+        
+  it "should sort a list by priority" do
+    tl = Rtodotxt::List.new a_list
+    tl_sorted = Rtodotxt::List.new a_list_sorted
+    tl.sort.should == tl_sorted
+  end
+  
+  it "should sort a list by done" do
+    tl = Rtodotxt::List.new b_list
+    tl_sorted = Rtodotxt::List.new b_list_sorted
+    tl.sort.should == tl_sorted
+  end
+  
+end
+
+describe Rtodotxt::Todo do
+  
+  it "should initialize with text" do
+    t = Rtodotxt::Todo.new a_todo
+    t.text.should eql a_todo
+  end
+  
+  it "should mark as done" do
+    t = Rtodotxt::Todo.new b_todo 
+    t.done!.text.should eql b_todo_done
+  end
+  
+  it "should not change a done todo if mark is done is called" do
+    t = Rtodotxt::Todo.new b_todo_done
+    t.done!.text.should eql b_todo_done
+  end
+
+  it "should mark as done with priority removed" do
+    t = Rtodotxt::Todo.new a_todo_prio 
+    t.done!.text.should eql a_todo_done
+  end
+  
+  it "should set priority" do
+    t = Rtodotxt::Todo.new b_todo
+    t.prio!("A").should eql b_todo_prio
+  end
+  
+  it "should unset priority" do
+    t = Rtodotxt::Todo.new b_todo_prio
+    t.prio!("").should eql b_todo
+  end
+  
+  it "should raise Argument error on illegal priority" do
+    t = Rtodotxt::Todo.new b_todo_prio
+    lambda { t.prio!("ABC") }.should raise_error
+  end
+    
+  it "should give its contexts" do
+   t = Rtodotxt::Todo.new "(C) +bbq @supermarket go +get some +bbq stuff @home for @home" 
+   t.contexts.should eql ["supermarket", "home"]
+  end
+  
+  it "should return its projects" do
+    t = Rtodotxt::Todo.new "(C) +bbq @supermarket go +get some +bbq stuff @home for @home" 
+    t.projects.should eql ["bbq", "get"]
+  end
+    
+  it "should return its priority" do
+    t = Rtodotxt::Todo.new "(C) something"
+    t.prio.should eql "C"
+  end
+  
+  it "should return empty string for no priority" do
+    t = Rtodotxt::Todo.new "something"
+    t.prio.should eql ""
+  end
+  
+  
+  it "should determine if a todo is done" do
+    t = Rtodotxt::Todo.new a_todo_done
+    t.done?.should eql true
+    t = Rtodotxt::Todo.new a_todo
+    t.done?.should eql false
+  end
+    
+  it "should evaluate lower prio to be smaller" do
+    t_c = Rtodotxt::Todo.new "(C) something"
+    t_b = Rtodotxt::Todo.new "(B) something"
+    t_c.should be > t_b
+  end
+
+  it "should evaluate lower equal and bigger accordingly" do
+    t_d = Rtodotxt::Todo.new a_todo_done
+    t_p = Rtodotxt::Todo.new a_todo_prio
+    t_n = Rtodotxt::Todo.new a_todo
+    t_d.should be > t_p
+    t_d.should be > t_n
+    t_p.should be < t_n
+    t_p.should be < t_d  
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "bundler/setup"
+
+require "rtodotxt"
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rtodotxt
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Philipp Fehre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Working with todo.txt file in ruby
+email:
+- philipp.fehre@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rtodotxt.rb
+- lib/rtodotxt/version.rb
+- rtodotxt.gemspec
+- spec/rtodotxt_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sideshowcoder/rtodotxt
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Use a todotxt formatted file in ruby
+test_files:
+- spec/rtodotxt_spec.rb
+- spec/spec_helper.rb