dst 0.0.1

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Simon Rozet
+
+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/Manifest

@@ -0,0 +1,7 @@
+README
+spec/dst_spec.rb
+LICENCE
+lib/dst/models.rb
+lib/dst.rb
+bin/dst
+Manifest

data/README

@@ -0,0 +1,41 @@
+dst is a KISS GTD manager for the command line lovers.
+
+== Licence
+
+dst is copyright 2008 Simon Rozet. It is licensed under the MIT licence.
+See the included LICENSE file for details.
+
+== Install
+
+  sudo gem install ape
+
+== Usage
+
+  % dst @mail john@doe.org about foo
+  1 - `@mail john@doe.org about foo' created.
+  % dst @code :myproj fix bug 123
+  2 - `@code :myproj fix bug 123' created.
+  % dst @code :myproj do foo and bar
+  3 - `@code :myproj do foo and bar' created.
+  % dst
+  1 - @mail john@doe.org about foo
+  2 - @code :myproj fix bug
+  3 - @code :myproj do foo and bar
+  % dst @mail
+  1 - @mail john@doe.org about foo
+  % dst :myproj
+  2 - @code :myproj fix bug
+  3 - @code :myproj do foo and bar
+  % dst ^2
+  Ok, `2 - @code :myproj fix bug' marked as `completed'.
+  % dst
+  1 - @mail john@doe.org about foo
+  3 - @code :myproj do foo and bar
+
+== Contact
+
+Simon Rozet, simon@rozet.name
+
+== Acknowledgements
+
+I originally wrote dst back in July 2007 with the help of Gregory Brown to whom I am very grateful.

data/bin/dst

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$:.unshift 'lib/', File.dirname(__FILE__) + '/../lib'
+require 'dst'
+
+Dst::Models.establish_connection(:database => File.expand_path('~/.dst.db'))
+Dst::Models.create_tables_if_necessary
+Dst.process_command(ARGV.join(' '))

data/dst.gemspec

@@ -0,0 +1,81 @@
+
+# Gem::Specification for Dst-0.0.1
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{dst}
+  s.version = "0.0.1"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simon Rozet"]
+  s.date = %q{2008-02-11}
+  s.default_executable = %q{dst}
+  s.description = %q{a KISS GTD manager for the command line lovers.}
+  s.email = %q{simon@rozet.name}
+  s.executables = ["dst"]
+  s.files = ["README", "spec/dst_spec.rb", "LICENCE", "lib/dst/models.rb", "lib/dst.rb", "bin/dst", "Manifest", "dst.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://atonie.org/2008/dst}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{dst}
+  s.rubygems_version = %q{1.0.1}
+  s.summary = %q{a KISS GTD manager for the command line lovers.}
+
+  s.add_dependency(%q<activerecord>, [">= 2.0.2"])
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'rake'
+# require 'spec/rake/spectask'
+# 
+# Version = '0.0.1'
+# 
+# begin
+#   require 'echoe'
+# 
+#   Echoe.new('dst', Version) do |p|
+#     p.summary = 'a KISS GTD manager for the command line lovers.'
+#     p.description = 'a KISS GTD manager for the command line lovers.'
+#     p.url = 'http://atonie.org/2008/dst'
+#     p.author = 'Simon Rozet'
+#     p.email = 'simon@rozet.name'
+#     p.dependencies  << 'activerecord >=2.0.2'
+#     p.clean_pattern << 'report.html'
+#     p.clean_pattern << 'coverage'
+#   end
+# rescue LoadError => boom
+#   puts 'You are missing a dependency required for meta-operations on this gem.'
+#   puts boom.to_s.capitalize
+# end
+# 
+# desc 'Install the package as a gem, without generating documentation'
+# task :install_gem_no_doc => [:clean, :package] do
+#   sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+# end
+# 
+# task :default => 'spec'
+# desc 'Run specs'
+# Spec::Rake::SpecTask.new do |t|
+#   t.spec_opts = ['--format', 'specdoc', '--colour', '--diff']
+# end
+# 
+# desc 'Generate coverage reports'
+# Spec::Rake::SpecTask.new('spec:coverage') do |t|
+#   t.rcov = true
+# end
+# 
+# desc 'Generate a nice HTML report of spec results'
+# Spec::Rake::SpecTask.new('spec:report') do |t|
+#   t.spec_opts = ['--format', 'html:report.html', '--diff']
+# end
+# 
+# task :publish_on_atonie => ['spec:coverage', 'spec:report'] do
+#   sh 'cp -R coverage ~/web/org.atonie./2008/dst/'
+#   sh 'cp report.html ~/web/org.atonie./2008/dst'
+#   sh '~/bin/publish_atonie'
+# end

data/lib/dst.rb

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'dst/models'
+
+class Dst
+  include Models
+  
+  def self.process_command(command)
+    new.process_command(command)
+  end
+
+  def process_command(command)
+    options = extract_options_from_command(command)
+    if command.blank? || !options.has_key?(:description)
+      list_tasks(options)
+    elsif command =~ /^\^(\d+)$/
+      toggle_task($1.to_i)
+    else
+      create_task(options)
+    end
+  end
+
+  def create_task(options={})
+    task = Task.new(:description => options[:description])
+    task.context = Context.find_or_create_by_name(options[:context]) if options.has_key?(:context)
+    task.project = Project.find_or_create_by_name(options[:project]) if options.has_key?(:project)
+    task.save
+    puts "`#{task}' created."
+  end
+
+  def toggle_task(task_id)
+    task = Task.toggle!(task_id)
+    puts "Ok, `#{task}' marked as `#{task.status}'."    
+  rescue ActiveRecord::RecordNotFound
+    puts "Oops, task ##{task_id} not found."
+  end
+
+  def list_tasks(options={}, include_completed=false)
+    context, project = options.values_at(:context, :project)
+    tasks = if options.empty?
+              Task.unfinished
+            elsif context
+              Task.unfinished.select { |task|
+                task.context.name == context if task.context
+              }
+            elsif project
+              Task.unfinished.select { |task|
+                task.project.name == project if task.project
+              }
+            end || []
+    puts tasks.empty? ? 'No tasks found' : tasks.map(&:to_s).join("\n")
+  end
+
+  protected
+    def extract_options_from_command(command)
+      context = command =~ /^@(\w+)/ && $1
+      project = command =~ /(?!\w):(\w+)/ && $1
+      description = command.dup
+      description.gsub!("@#{context}", '') unless context.nil?
+      description.gsub!(":#{project}", '') unless project.nil?
+      options = {:context => context, :project => project, :description => description.strip}
+      options.reject { |k, v| v.nil? || v.blank? }
+    end
+end

data/lib/dst/models.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'active_record'
+
+class Dst
+  module Models
+    class << self
+      def schema(&block)
+        @@schema = block if block_given?
+        @@schema
+      end
+
+      def establish_connection(options={})
+        ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => 'dst.db'}.merge(options))
+      end
+      
+      def create_tables_if_necessary(force=false)
+        ActiveRecord::Schema.define(&Dst::Models.schema) if force || !Task.table_exists?
+      end
+    end
+
+    class Task < ActiveRecord::Base
+      belongs_to :context
+      belongs_to :project
+
+      def self.unfinished(options={})
+        find(:all, :conditions => 'status = "f"', :include => [:context, :project], :order => 't1_r1')
+      end
+
+      def self.toggle!(task_id)
+        task = find(task_id)
+        task.toggle!(:status)
+        task
+      end
+
+      def status
+        read_attribute(:status) ? 'completed' : 'unfinished'  
+      end
+
+      def to_s
+        "#{id} - #{context || ''}#{project || ''}#{description}"
+      end
+    end
+
+    class Context < ActiveRecord::Base
+      has_many :tasks
+
+      def to_s
+        name ? "@#{name} ": ""
+      end
+    end
+
+    class Project < ActiveRecord::Base
+      has_many :tasks
+
+      def to_s
+        name ? ":#{name} ": ""
+      end
+    end
+  end
+end
+
+Dst::Models.schema do
+  create_table :tasks do |t|
+    t.string  :description
+    t.boolean :status, :default => false
+    t.integer :context_id
+    t.integer :project_id
+    t.timestamps
+  end
+
+  create_table :contexts do |t|
+    t.string :name
+  end
+
+  create_table :projects do |t|
+    t.string :name
+  end
+end

data/spec/dst_spec.rb

@@ -0,0 +1,181 @@
+$:.unshift 'lib/', File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'spec'
+require 'dst'
+
+module Kernel; def puts(s); end; end
+
+describe Dst do
+  before(:each) do
+    @dst = Dst.new
+    @task_model = Dst::Models::Task
+    @context_model = Dst::Models::Context
+    @project_model = Dst::Models::Project
+
+    @task = mock('Task', :context= => true, :project= => true, :save => true)
+    @task_model.stub!(:new).and_return(@task)
+  end
+
+  it 'should exists' do
+    @dst.should_not be_nil
+    @dst.should be_an_instance_of(Dst)
+  end
+
+  describe "when creating tasks: `<@context> <:project> task'" do
+    before(:each) do
+      @command = '@mail :proj john@doe.name about http://example.org'
+    end
+
+    describe '#process_command' do
+      it 'dispatchs command to create_task' do
+        @dst.should_receive(:create_task)
+        @dst.process_command(@command)
+      end
+
+      it 'parses description correctly' do
+        @dst.should_receive(:create_task) do |opts|
+          opts[:description].should == 'john@doe.name about http://example.org' 
+        end
+        @dst.process_command(@command)
+      end
+
+      it 'parses context correctly' do
+        @dst.should_receive(:create_task) { |opts| opts[:context].should ==  'mail' } 
+        @dst.process_command(@command)
+      end
+
+      it 'parses project correctly' do
+        @dst.should_receive(:create_task) { |opts| opts[:project].should == 'proj' }
+        @dst.process_command(@command)
+      end
+    end
+
+    describe '#create_task' do
+      before(:each) do
+        @context = mock('Context')
+        @context_model.stub!(:find_or_create_by_name).and_return(@context)
+
+        @project = mock('Project')
+        @project_model.stub!(:find_or_create_by_name).and_return(@project)
+      end
+
+      it 'creates a new Task with given description' do
+        @task_model.should_receive(:new).with(
+          :description  => 'john@doe.name about http://example.org'
+        ).and_return(@task) 
+        @dst.process_command(@command)
+      end
+  
+      it 'finds or creates context' do
+        @context_model.should_receive(:find_or_create_by_name).and_return(@context)
+        @dst.process_command(@command)
+      end
+
+      it "sets task's context if specified" do
+        @task.should_receive(:context=).with(@context)
+        @dst.process_command(@command)
+      end
+
+      it "doesn't set tasks's context if not specified" do
+        @task.should_not_receive(:context=)
+        @dst.process_command('task without context')
+      end
+
+      it "finds or creates project" do
+        @project_model.should_receive(:find_or_create_by_name).and_return(@project)
+        @dst.process_command(@command)
+      end
+
+      it "sets task's project if specified" do
+        @task.should_receive(:project=).with(@project)
+        @dst.process_command(@command)
+      end
+
+      it "doesn't set tasks's project if not specified" do
+        @task.should_not_receive(:project=)
+        @dst.process_command('task without project')
+      end
+
+      it 'saves new task' do
+        @task.should_receive(:save).and_return(true)
+        @dst.process_command(@command)
+      end
+
+      it 'notices that tasks have been successfuly created' do
+        @dst.should_receive(:puts).with(/ created.$/)
+        @dst.process_command(@command)
+      end
+    end
+  end
+
+  describe "when toggling a task: `^<task id>'" do
+    before(:each) do
+      @task.stub!(:status).and_return(true)
+      @task_model.stub!(:toggle!).and_return(@task)
+    end
+
+    describe '#proccess_command' do
+      it 'dispatchs to toggle_task' do
+        @dst.should_receive(:toggle_task).with(479)
+        @dst.process_command('^479')
+      end
+
+      it 'parses task id correctly' do
+        [1, 479, 0, 1087].each do |id|
+          @dst.should_receive(:toggle_task).with(id)
+          @dst.process_command("^#{id}")
+        end
+      end
+    end
+
+    describe '#toggle_task' do
+      it 'toggle task' do
+        @task_model.should_receive(:toggle!).with(3).and_return(@task)
+        @dst.process_command('^3')
+      end
+
+      it 'outputs an error message if task not found' do
+        @task_model.should_receive(:toggle!).and_raise(ActiveRecord::RecordNotFound)
+        @dst.should_receive(:puts).with("Oops, task #98 not found.")
+        @dst.process_command('^98')
+      end
+    end
+  end
+
+  describe "when listing tasks: `[<@context> <@project>] [-a]]'" do
+    before(:each) do
+      @tasks = mock('tasks', :select => [@task], :empty? => false, :map => [@task])
+      @task_model.stub!(:unfinished).and_return(@tasks)
+    end
+
+    it 'finds all unfinished tasks if no filter provided' do
+      @task_model.should_receive(:unfinished).and_return(@tasks)
+      @tasks.should_not_receive(:select)
+      @dst.process_command('')
+    end
+
+    it 'finds unfinished tasks filtered by context' do
+      @task_model.should_receive(:unfinished).and_return(@tasks)
+      @tasks.should_receive(:select)
+      @dst.process_command('@context')
+    end
+
+    it 'finds unfinished tasks filtered by project' do
+      @task_model.should_receive(:unfinished).and_return(@tasks)
+      @tasks.should_receive(:select)
+      @dst.process_command(':project')
+    end
+    
+   it 'outputs tasks' do
+      @tasks.should_receive(:map).and_return(@tasks)
+      @tasks.should_receive(:join).and_return("")
+      @dst.process_command('')
+    end
+
+    it 'notices if no tasks found' do
+      @tasks.should_receive(:empty?).and_return(true)
+      @dst.should_receive(:puts).with('No tasks found')
+      @dst.process_command('')
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: dst
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simon Rozet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: a KISS GTD manager for the command line lovers.
+email: simon@rozet.name
+executables: 
+- dst
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- spec/dst_spec.rb
+- LICENCE
+- lib/dst/models.rb
+- lib/dst.rb
+- bin/dst
+- Manifest
+- dst.gemspec
+has_rdoc: true
+homepage: http://atonie.org/2008/dst
+post_install_message: 
+rdoc_options: []
+
+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: dst
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: a KISS GTD manager for the command line lovers.
+test_files: []
+