todo_list 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTU2MmM1NWQ2Njg0YzhiNTk4MzhhNTNkOTM4Njk5YzAxOTk1YTBjZQ==
+  data.tar.gz: !binary |-
+    ODFmMjQyNDE4YjA3MjVkOGMyM2QzYjY3YWYxMmY1OGI5OGNhZDU5OQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGQyZWQ1MWIxOTk3N2RmMDRiMzEzNGQ2NjdlNDVkM2YwZDA1MDhkMGVkNTY3
+    YjNlYTA4ODdhZDJiMWJiNDc3MzU2NzA4NTQwM2U5OTdkNTIzNDRiYmJlOTEz
+    YWNmNGU3OGI2MWQxZTUzMDg5NDliYjBmM2EwYmIzYjRmMDM0NjI=
+  data.tar.gz: !binary |-
+    MzM1YzQ1MjA3ZTU0ZTZjNWNlOTQyNTI1MWI2NTBjNDViNzI0NmRiNmEyMGQ0
+    NGFiNWUxMWFjMmI1MDMzOThiMGU5OGJkNzNiN2IwNTdmYzZkZDZjZGFhYzYx
+    MjEyM2EyNGI2ZTdmY2E5NDgyOWRjZGYzNjVhNzA1NTU0ZjY3ZGU=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jerome Dalbert
+
+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,32 @@
+# TodoList
+
+Basic command-line todo-list :
+
+ - list, add, edit and remove tasks
+ - *done* tasks remain displayed (more rewarding) until you clean them
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'todo_list'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install todo_list
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/todo

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require_relative '../lib/todo_list'
+
+TodoList::CommandLineInterface.new.run
+
+

data/lib/todo_list.rb

@@ -0,0 +1,10 @@
+require_relative "todo_list/version"
+require_relative "todo_list/command_line_interface"
+require_relative "todo_list/task_list"
+require_relative "todo_list/task"
+require_relative "todo_list/core_ext/string"
+
+module TodoList
+  ROOT_PATH = File.expand_path('../', File.dirname(__FILE__))
+  SAVE_PATH = File.join(ROOT_PATH, '/todo.sav')
+end

data/lib/todo_list/command_line_interface.rb

@@ -0,0 +1,154 @@
+require 'rb-readline'
+
+module TodoList
+  class CommandLineInterface
+
+    def run
+      command = ARGV[0]
+      command ||= "print_list"
+
+      if respond_to?(command)
+        execute(command)
+      else
+        print_command_error(%(Unknown command #{bold(command)}.))
+      end
+    end
+
+    def add
+      description = ARGV[1..-1].join(" ")
+
+      @task_list << Task.new(description) unless description.empty?
+
+      print_list
+    end
+
+    def edit
+      task = get_todo_tasks[get_task_index]
+
+      if ARGV.size > 2
+        task.description = ARGV[2..-1].join(" ")
+      else
+        RbReadline.prefill_prompt(task.description)
+        task.description = Readline.readline("Edit description: ")
+      end
+
+      print_list
+    end
+
+    def done
+      get_todo_tasks[get_task_index].done = true
+
+      print_list
+    end
+
+    def remove
+      @task_list.delete(get_todo_tasks[get_task_index])
+
+      print_list
+    end
+
+    def clean
+      @task_list = TaskList.new(get_todo_tasks)
+
+      print_list
+    end
+
+    def wipe
+      @task_list = TaskList.new
+
+      print_list
+    end
+
+    def print_list
+      if @task_list.empty?
+        puts %(Nothing to do !\n\nType "help" command for more information.)
+        return
+      end
+
+      unless get_todo_tasks.empty?
+        puts "[TODO]"
+        get_todo_tasks.each_with_index do |e, i|
+          puts "#{i + 1} - #{e.description.capitalize}"
+        end
+        puts unless get_done_tasks.empty?
+      end
+
+      unless get_done_tasks.empty?
+        puts "[DONE]"
+        get_done_tasks.each do |e|
+          puts "- #{e.description.capitalize}"
+        end
+      end
+    end
+
+    def print_help
+      puts <<-ENDTEXT
+Available commands :
+    help
+    add    #{underline("task_description")}
+    edit   #{underline("task_number")} [#{underline("new_description")}]
+    done   #{underline("task_number")}
+    remove #{underline("task_number")}
+    clean
+    wipe
+ENDTEXT
+    end
+
+    alias_method :help, :print_help
+
+    private
+
+    def execute(command)
+      @task_list = TaskList.load(SAVE_PATH)
+
+      send(command)
+
+      @task_list.save(SAVE_PATH)
+    end
+
+    def get_done_tasks
+      @task_list.select { |e| e.done? }
+    end
+
+    def get_todo_tasks
+      @task_list.select { |e| !e.done? }
+    end
+
+    def print_command_error(error_message)
+      print("#{error_message}\n\n")
+
+      print_help
+    end
+
+    def underline(string)
+      "\033[4m#{string}\033[0m"
+    end
+
+    def bold(string)
+      "\033[1m#{string}\033[0m"
+    end
+
+    def get_task_index
+      task_index = ARGV[1].to_i - 1
+
+      unless task_index.between?(0, get_todo_tasks.size - 1)
+        puts "Please type a valid task number."
+        exit
+      end
+
+      task_index
+    end
+  end
+end
+
+module RbReadline
+  def self.prefill_prompt(str)
+    @rl_prefill = str
+    @rl_startup_hook = :rl_prefill_hook
+  end
+
+  def self.rl_prefill_hook
+    rl_insert_text @rl_prefill if @rl_prefill
+    @rl_startup_hook = nil
+  end
+end

data/lib/todo_list/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+
+  def to_b
+    self == "true"
+  end
+
+end

data/lib/todo_list/task.rb

@@ -0,0 +1,13 @@
+module TodoList
+  class Task
+
+    attr_accessor :description, :done
+    alias_method :done?, :done
+
+    def initialize(description, done = false)
+      self.description = description
+      self.done = done
+    end
+
+  end
+end

data/lib/todo_list/task_list.rb

@@ -0,0 +1,27 @@
+module TodoList
+  class TaskList < Array
+
+    SEPARATOR = " _;_ "
+
+    def self.load(file_name)
+      todolist = TaskList.new
+
+      if File.exists?(file_name)
+        File.foreach(file_name) do |line|
+          description, done = line.chomp.split(SEPARATOR)
+
+          todolist << Task.new(description, done.to_b)
+        end
+      end
+
+      todolist
+    end
+
+    def save(file_name)
+      File.open(file_name, "w") do |file|
+        self.each { |e| file.puts("#{e.description}#{SEPARATOR}#{e.done?}") }
+      end
+    end
+
+  end
+end

data/lib/todo_list/version.rb

@@ -0,0 +1,3 @@
+module TodoList
+  VERSION = "0.1.1"
+end

data/todo_list.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'todo_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "todo_list"
+  spec.version       = TodoList::VERSION
+  spec.authors       = ["Jerome Dalbert"]
+  spec.email         = ["jerome.dalbert@gmail.com"]
+  spec.description   = %q{Basic command-line todo-list}
+  spec.summary       = %q{List, add, edit and remove tasks. Done tasks remain displayed (more rewarding) until you clean them.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "rb-readline"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: todo_list
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jerome Dalbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic command-line todo-list
+email:
+- jerome.dalbert@gmail.com
+executables:
+- todo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/todo
+- lib/todo_list.rb
+- lib/todo_list/command_line_interface.rb
+- lib/todo_list/core_ext/string.rb
+- lib/todo_list/task.rb
+- lib/todo_list/task_list.rb
+- lib/todo_list/version.rb
+- todo_list.gemspec
+homepage: ''
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: List, add, edit and remove tasks. Done tasks remain displayed (more rewarding)
+  until you clean them.
+test_files: []