ztodo 1.0.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.rbc
+.bundle
+coverage
+doc/
+lib/bundler/man
+pkg/*
+rdoc
+spec/reports
+tmp/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ztodo.gemspec
+gemspec
+
+
+gem 'rspec'
+gem 'colorize'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    ztodo (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize
+  rspec
+  ztodo!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andreas Sotnik <andreas.sotnik@gmail.com>
+
+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,35 @@
+# ztodo
+
+Simple Console Task Manager.
+
+## Installation
+
+Install gem:
+
+    $ gem install ztodo
+
+## Basic Usage
+
+Initializing ztodo project in current folder:
+
+    $ ztodo init
+
+List of uncompleted tasks (or all tasks in project):
+
+    $ ztodo list [all]
+
+Add task to project (%key% determines task in project, unique identifier):
+
+    $ ztodo add
+
+Modify task:
+
+    $ ztodo modify %key%
+
+Remove task:
+
+    $ ztodo remove %key%
+
+You may call ztodo without parameters for getting help and information about current project:
+
+    $ ztodo

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/bin/ztodo.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'ztodo'
+
+c = Ztodo::Controller.new
+c.execute! ARGV

data/lib/ztodo/controller.rb

@@ -0,0 +1,158 @@
+require 'colorize'
+=begin
+  Class for processing user commands.
+  This class uses Ztodo::Project and Ztodo::Converter classes
+=end
+class Ztodo::Controller
+
+  def initialize
+    @proj = Ztodo::Project.new
+    @conv = Ztodo::Converter.new
+  end
+
+  # Execute necessary command
+  def execute! args
+    return cmd_help if args.empty?
+
+    handler = args[0]
+
+    if methods.include? ('cmd_'+handler).to_sym
+      args.slice! 0
+      method(('cmd_'+handler).to_sym).call args
+    else
+      cmd_help
+    end
+  end
+
+  protected
+
+  # Print help message
+  def cmd_help params=[]
+    puts 'ztodo - Simple Command Line Task Manager'.light_blue
+    puts 'Usage:'
+
+    puts '> ztodo'.green
+    puts '> ztodo help'.green
+    puts '> ztodo init'.yellow
+    puts '> ztodo init hard'.yellow
+    puts '> ztodo list'.green
+    puts '> ztodo list all'.green
+    puts '> ztodo add'.yellow
+    puts '> ztodo add %task-key%'.yellow
+    puts '> ztodo modify %task-key%'.yellow
+    puts '> ztodo remove %task-key%'.yellow
+  end
+  
+  def cmd_init params=[]
+    if File.exists?(Dir.pwd+'/.ztodo') && params[0] != 'hard'
+      puts "ztodo project already existed. Run 'ztodo init hard' for re-init".red
+      return
+    end
+    @proj.init!
+    puts 'ztodo project initialized.'.green
+  end
+
+  def format_task task
+    puts task[:key].to_s+' '+ @conv.colored_priority(task[:priority]) +
+          ' ('+(task[:done] ? 'done'.green : 'undone'.yellow)+')'       
+    puts task[:description].to_s.light_blue
+    puts ''
+  end
+
+  def cmd_list params=[]
+    load_or_die
+    show_all_tasks = params[0] == 'all'
+
+    tasks = @proj.tasks(show_all_tasks)
+    puts ''
+    orig = []
+    tasks.each do |key, task|      
+      ind = (task[:done] ? 5 : 0) - task[:priority] + 1
+      orig[ind] = [] if orig[ind].nil?
+      orig[ind].push task
+    end
+
+    orig.each do |task_list|
+      if task_list.class == Array
+        task_list.each do |task|
+          format_task task
+        end
+      end
+    end
+  end
+
+  def cmd_add params=[]
+    load_or_die
+    task = @proj.create
+    original_key = params.join(' ')
+    unless original_key.empty?
+      task[:key] = original_key.to_sym
+    end
+    File.open(Dir.pwd+'/.ztodo-tmp', 'w+') {|f| f.write(@conv.hash_to_str task) }
+    
+    exit unless system("editor .ztodo-tmp")
+
+    File.open(Dir.pwd+'/.ztodo-tmp') { |f|
+      task = @conv.str_to_hash f.read
+
+      begin
+        @proj.add task
+      rescue Exception, e
+        puts 'Task with such key already exists. Postfix added'.yellow
+        task[:key] += Random.rand(1000).to_s
+        @proj.add task
+      end
+      @proj.save!
+    }
+   
+    File.delete Dir.pwd+'/.ztodo-tmp'
+  end
+
+  def cmd_modify params=[]
+    load_or_die
+    original_key = params.join(' ').to_sym
+    task = @proj.tasks(true)[original_key]
+    if task.nil?
+      puts 'Invalid task key'.red
+      exit
+    end
+    File.open(Dir.pwd+'/.ztodo-tmp', 'w+') {|f| f.write(@conv.hash_to_str task) }
+    
+    exit unless system("editor .ztodo-tmp")
+
+    File.open(Dir.pwd+'/.ztodo-tmp') { |f|
+      task = @conv.str_to_hash f.read
+
+      begin
+        @proj.modify original_key, task
+      rescue Exception, e
+        puts 'Task with such key already exists. Postfix added'.yellow
+        task[:key] += Random.rand(1000).to_s
+        @proj.modify original_key, task
+      end
+      @proj.save!
+    }
+   
+    File.delete Dir.pwd+'/.ztodo-tmp'
+  end
+
+  def cmd_remove params=[]
+    load_or_die
+    begin
+      @proj.remove params.join(' ').to_sym
+    rescue Exception, e
+      puts 'Invalid task key'.red
+    end
+    @proj.save!
+  end
+
+  def load_or_die
+    unless File.exists? Dir.pwd+'/.ztodo'
+      puts 'ztodo project is not initialized! Run "ztodo init"'.red
+      exit
+    end
+
+    @proj.load!
+  end
+
+end

data/lib/ztodo/converter.rb

@@ -0,0 +1,106 @@
+=begin
+  Class for converting task hashes to strings and vice versa
+=end
+class Ztodo::Converter
+  
+  # Convert string representation of task to hash  
+  def str_to_hash str
+    out = {}
+    data = str.split("\n")
+    out[:key] = parse_key_line data[0]
+    out[:priority] = parse_priority_line data[1]
+    out[:done] = parse_completeness_line data[2]
+    out[:description] = extract_description data.clone
+    out
+  end
+
+  # Convert hash representation of task to string
+  def hash_to_str hash
+    out = ''
+    out += hash[:key].to_s+" # unique identifier of task\n"
+    out += format_priority(hash[:priority])+" # priority: 'low', 'normal' or 'high'\n"
+    out += (hash[:done] ? 'done' : 'undone' )+" # task completeness: 'done' or 'undone'\n"
+    out += hash[:description].to_s
+    out
+  end
+
+  def colored_priority int_val
+    require 'colorize'
+    if int_val == Ztodo::Project::LOW
+      'low'.green
+    elsif int_val == Ztodo::Project::NORMAL
+      'normal'.yellow
+    elsif int_val == Ztodo::Project::HIGH
+      'high'.red
+    else
+      raise Exception.new('Priority should be -1, 0 or 1. Given: '+int_val)
+    end
+  end
+
+  protected 
+
+  # Format priority integer value as string
+  def format_priority int_val
+    if int_val == Ztodo::Project::LOW
+      'low'
+    elsif int_val == Ztodo::Project::NORMAL
+      'normal'
+    elsif int_val == Ztodo::Project::HIGH
+      'high'
+    else
+      raise Exception.new('Priority should be -1, 0 or 1. Given: '+int_val)
+    end
+  end
+
+  # Parse line with unique identifier
+  def parse_key_line line
+    line = clear_line line    
+    if line.nil? || line.empty? 
+      'task'+Random.rand(1000).to_s
+    else 
+      line
+    end
+  end
+
+  # Parse line with priority data
+  def parse_priority_line line
+    return Ztodo::Project::NORMAL if line.nil? || line.empty?
+    line = clear_line line    
+
+    if line == 'low'
+      Ztodo::Project::LOW    
+    elsif line == 'high'
+      Ztodo::Project::HIGH
+    else # 'normal' and any other option
+      Ztodo::Project::NORMAL
+    end
+  end
+
+  # Parse line with completeness data
+  def parse_completeness_line line    
+    line = clear_line line    
+    return line == 'done'
+  end
+
+
+  # Return line without commented part
+  def clear_line line
+    return nil if line.nil?
+
+    if line.index('#').nil?
+      res = line
+    else
+      res = line[0,line.index('#')]
+    end
+    res.strip!
+    return res
+  end
+
+  # Return description data
+  def extract_description splitted_data    
+    return '' if splitted_data.size<=3
+    3.times { splitted_data.slice! 0 }    
+    splitted_data.join "\n"
+  end
+
+end

data/lib/ztodo/project.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+
+=begin
+  Represent Project object.  
+=end
+class Ztodo::Project
+  
+  attr_reader :loaded
+
+  LOW = -1
+  NORMAL = 0
+  HIGH = 1
+
+  def initialize
+    @loaded = false
+    @data = {}
+  end
+
+  # Init project file (.ztodo) in current directory
+  def init!
+    @data = {}
+    save!
+  end
+
+  # load project from file in current directory
+  def load!
+    raise Exception.new('ztodo project file is not exists') unless File.exists?(Dir.pwd+'/.ztodo')
+
+    @data = YAML::load(File.open(Dir.pwd+'/.ztodo'))
+    @loaded = true
+  end
+
+  # Save project to file in current directory
+  def save!    
+    File.open(Dir.pwd + '/.ztodo', 'w+') { |f| f.write(@data.to_yaml) }
+    @loaded = true
+  end
+
+  # Return all tasks  
+  def tasks show_all = FALSE
+    return @data.reject {|k,v| v[:done]} if !show_all    
+    @data.clone
+  end
+
+  # Add task
+  # Raise en exception if key is already used
+  def add task
+    raise Exception.new('Such key already exists') if @data.include?(task[:key].to_sym)
+    @data[task[:key].to_sym] = task
+  end
+
+  # Modify task
+  # Raise en exception if there is no task with such key
+  def modify key, task
+    raise Exception.new('No task with such key') unless @data.include?(key.to_sym)
+    @data.delete key
+    add task
+  end
+
+  # Remove task
+  # Raise en exception if there is no task with such key
+  def remove key
+    raise Exception.new('No task with such key') unless @data.include?(key.to_sym)
+    @data.delete key
+  end
+
+  # Create task (but not add it to data)
+  def create
+    {:key=>'key', :description=>'put description here', 
+      :done=>false, :priority=> Ztodo::Project::NORMAL}
+  end  
+
+end

data/lib/ztodo/version.rb

@@ -0,0 +1,3 @@
+module Ztodo
+  VERSION = "1.0.0"
+end

data/lib/ztodo.rb

@@ -0,0 +1,10 @@
+require "ztodo/version"
+require "ztodo/controller"
+require "ztodo/project"
+require "ztodo/converter"
+
+=begin
+  Module for Console Task Manager
+=end
+module Ztodo
+end

data/spec/converter_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Ztodo::Converter do
+
+  before(:all) { @conv = Ztodo::Converter.new }
+
+  it 'can convert string to task hash' do
+    input = "test_title # unique identifier of task\n" +             
+            "low # priority: 'low', 'normal' or 'high'\n" +
+            "done # task completeness: 'done' or 'undone'\n"+
+            "Here will be task\n" +
+            "Maybe in two lines"
+
+    output = {:key=>'test_title', :priority=>Ztodo::Project::LOW,
+              :description=>"Here will be task\nMaybe in two lines", :done=>true}
+
+    out = @conv.str_to_hash input
+    out.should eq(output)
+  end
+
+  it 'can convert task hash to string' do
+    input = {:key=>'my_task', :priority=>Ztodo::Project::HIGH,
+              :description=>"Task description\nwith two lines", :done=>true}
+
+    output = "my_task # unique identifier of task\n" +
+             "high # priority: 'low', 'normal' or 'high'\n" +
+             "done # task completeness: 'done' or 'undone'\n"+
+             "Task description\nwith two lines"
+
+    out = @conv.hash_to_str input
+    out.should eq(output)
+  end
+
+end

data/spec/project_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Ztodo::Project do
+
+  it 'has methods: init, save and load' do
+    methods = [:init!, :save!, :load!]
+    methods.each { |method_name| Ztodo::Project.methods.include?(method_name) }
+  end
+
+  it 'can add tasks' do
+    p = Ztodo::Project.new    
+    task = {:key=>'task_A', :priority=>Ztodo::Project::NORMAL,
+              :description=>"description for A task", :done=>false} 
+    p.add task    
+    tasks = p.tasks
+    tasks[:task_A].should eq(task)
+  end
+
+  it 'can modify tasks' do
+    p = Ztodo::Project.new    
+    task = {:key=>'task_A', :priority=>Ztodo::Project::NORMAL,
+              :description=>"description for A task", :done=>false} 
+    task2 = {:key=>'task_B', :priority=>Ztodo::Project::HIGH,
+              :description=>"description for B task", :done=>true} 
+    p.add task
+    p.modify :task_A, task2
+
+    tasks = p.tasks true
+    tasks[:task_A].should eq(nil)
+    tasks[:task_B].should eq(task2)
+  end
+
+  it 'can delete tasks' do
+    p = Ztodo::Project.new    
+    task = {:key=>'task_A', :priority=>Ztodo::Project::NORMAL,
+              :description=>"description for A task", :done=>false}     
+    p.add task        
+    p.tasks(true)[:task_A].should eq(task)
+    p.remove :task_A
+    p.tasks(true)[:task_A].should eq(nil)    
+  end
+
+  it 'can list uncompleted tasks' do
+    p = Ztodo::Project.new
+    
+    task = {:key=>'task_A', :priority=>Ztodo::Project::NORMAL,
+              :description=>"description for A task", :done=>false} 
+    task2 = {:key=>'task_B', :priority=>Ztodo::Project::NORMAL,
+              :description=>"description for B task", :done=>true} 
+    p.add task
+    p.add task2
+
+    tasks = p.tasks
+    tasks[:task_B].should eq(nil)
+    tasks[:task_A].should eq(task)
+
+    tasks = p.tasks true
+    tasks.size.should eq(2)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'ztodo'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+
+  config.before(:all) do
+    if Dir.exists?(Dir.pwd + '/tmp')
+      @old_dir = Dir.pwd
+      Dir.chdir (Dir.pwd + '/tmp')
+    end
+  end
+
+  config.after(:all) do
+    unless Dir.pwd == @old_dir
+      Dir.chdir @old_dir      
+    end
+  end
+
+  config.after(:each) do 
+    File.delete(Dir.pwd+'/.todo') if File.exists?(Dir.pwd+'/.todo')
+  end
+
+end

data/ztodo.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ztodo/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ztodo"
+  gem.version       = Ztodo::VERSION
+  gem.authors       = ["Andreas Sotnik"]
+  gem.email         = ["andreas.sotnik@gmail.com"]
+  gem.description   = 'Simple Console Task Manager. Check http://zenturio.me/pages/ztodo for further information.'
+  gem.summary       = 'Simple Console Task Manager'
+  gem.homepage      = "http://zenturio.me/pages/ztodo"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('colorize')
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: ztodo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andreas Sotnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Console Task Manager. Check http://zenturio.me/pages/ztodo for
+  further information.
+email:
+- andreas.sotnik@gmail.com
+executables:
+- ztodo.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ztodo.rb
+- lib/ztodo.rb
+- lib/ztodo/controller.rb
+- lib/ztodo/converter.rb
+- lib/ztodo/project.rb
+- lib/ztodo/version.rb
+- spec/converter_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- tmp/.gitkeep
+- ztodo.gemspec
+homepage: http://zenturio.me/pages/ztodo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Console Task Manager
+test_files:
+- spec/converter_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb