goldie 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -4,7 +4,9 @@ PATH
     goldie (0.0.1)
       activerecord
       bundler
+      smart_colored
       sqlite3
+      terminal-table
 
 GEM
   remote: http://rubygems.org/
@@ -25,7 +27,9 @@ GEM
     i18n (0.6.1)
     multi_json (1.3.6)
     rake (0.9.2.2)
+    smart_colored (1.1.1)
     sqlite3 (1.3.6)
+    terminal-table (1.4.5)
     tzinfo (0.3.33)
 
 PLATFORMS

data/README.md

@@ -0,0 +1,34 @@
+# Goldie
+
+Goldie is a command line todo list with lots of progress bars. Progress is its middle name.
+
+## Install
+
+    $ gem install goldie
+
+## Usage
+
+Run it like this:
+
+    $ goldie
+
+It will set up the database in a folder called .goldie in your $HOME. Then you
+can start adding todo items:
+
+    $ goldie add "take out the trash"
+
+This adds an item with a default weight of 1. The weight of each item determines
+how much it affects your overall progress bar. It can be any integer. I like to
+set the weight to the number of minutes I think each task will take me.
+
+    $ goldie add "read chapter 5" 60
+
+Then if I get that task half done, I can mark it as such:
+
+    $ goldie done 2 30
+
+This marks task #2 as 30 minutes done, out of 60.
+
+There are many more commands. Commands are simply Ruby methods. You can use the
+'help' command to list them all, or read lib/goldie/commands.rb for details, for
+now.

data/bin/goldie

@@ -13,6 +13,10 @@ DB_PATH = File.join(DIR, "todo.sqlite3")
 
 db = Goldie::Database.new(DB_ADAPTER, DB_PATH)
 
-ARGV << "progress_list" if ARGV.empty?
-
-Goldie::Commands.send(*ARGV)
+if ARGV.empty?
+  Goldie::Commands.list_progress
+elsif not Goldie::Commands::COMMAND_LIST.keys.map(&:to_s).include? ARGV.first
+  puts "Nonexistant command '#{ARGV.first}'. Type 'goldie help' for help."
+else
+  Goldie::Commands.send(*ARGV)
+end

data/goldie.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = "goldie"
-  s.version = "0.0.1"
-  s.date = "2012-09-21"
-  s.summary = "A todo list with a progress bar."
-  s.description = "Goldie is a simple command line todo list with a progress bar."
+  s.version = "0.0.2"
+  s.date = "2012-09-22"
+  s.summary = "A command line todo list."
+  s.description = "Goldie is a command line todo list with lots of progress bars. Progress is its middle name."
   s.author = "Jeremy Ruten"
   s.email = "jeremy.ruten@gmail.com"
   s.homepage = "http://github.com/yjerem/goldie"
@@ -11,11 +11,11 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9.2"
   s.executables << "goldie"
 
-  s.files = ["Gemfile", "Gemfile.lock", "LICENSE", "goldie.gemspec"]
+  s.files = ["Gemfile", "Gemfile.lock", "LICENSE", "goldie.gemspec", "README.md"]
   s.files += ["bin/goldie"]
   s.files += Dir["lib/**/*.rb"]
 
-  %w(bundler sqlite3 activerecord).each do |gem_name|
+  %w(bundler sqlite3 activerecord smart_colored terminal-table).each do |gem_name|
     s.add_runtime_dependency gem_name
   end
 

data/lib/goldie.rb

@@ -1,4 +1,6 @@
 require "active_record"
+require "smart_colored"
+require "terminal-table"
 
 require "goldie/database"
 require "goldie/item"

data/lib/goldie/commands.rb

@@ -1,53 +1,104 @@
 module Goldie
   module Commands
+    COMMAND_LIST = {
+      add: "create a new item",
+      update: "modify an item",
+      done: "mark an item as done",
+      not_done: "mark an item as not done",
+      archive: "archive an item",
+      unarchive: "unarchive an item",
+      delete: "delete an item",
+      list: "list certain items",
+      progress: "show progress bar",
+      list_progress: "list items and show progress bar",
+      help: "list available commands"
+    }
+
     extend self
 
     def add(title, weight = 1)
       item = Item.new(title: title, weight: weight)
       if item.save
-        puts "Item saved."
+        puts "Added item ##{item.id}."
+        puts
+        list_progress
       else
         puts "Item couldn't be saved:"
-        item.errors.messages.each do |field, messages|
-          messages.each do |message|
-            puts "- #{field} #{message}"
+        _display_errors(item)
+      end
+    end
+
+    def update(id, field, value)
+      if item = _find_item(id)
+        if %w(title weight weight_completed).include? field
+          if item.update_attributes(field => value)
+            puts "Updated item ##{item.id}."
+            puts
+            list_progress
+          else
+            puts "Item couldn't be updated:"
+            _display_errors(item)
           end
+        else
+          puts "Item couldn't be updated:"
+          puts "- #{field} isn't a valid field"
         end
       end
     end
 
-    def check(id)
+    def done(id, weight_completed = nil)
       if item = _find_item(id)
-        item.update_column :done, true
-        puts "Item checked off."
+        if weight_completed
+          if item.update_attributes(weight_completed: weight_completed)
+            puts "Item ##{item.id} updated."
+            puts
+            list_progress
+          else
+            puts "Item couldn't be updated:"
+            _display_errors(item)
+          end
+        else
+          item.done!
+          puts "Item ##{item.id} marked as done."
+          puts
+          list_progress
+        end
       end
     end
 
-    def uncheck(id)
+    def not_done(id)
       if item = _find_item(id)
-        item.update_column :done, false
-        puts "Item unchecked."
+        item.not_done!
+        puts "Item ##{item.id} marked as not done."
+        puts
+        list_progress
       end
     end
 
     def archive(id)
       if item = _find_item(id)
-        item.update_column :archived, true
-        puts "Item archived."
+        item.archive!
+        puts "Archived item ##{item.id}."
+        puts
+        list_progress
       end
     end
 
     def unarchive(id)
       if item = _find_item(id)
-        item.update_column :archived, false
-        puts "Item unarchived."
+        item.unarchive!
+        puts "Unarchived item ##{item.id}."
+        puts
+        list_progress
       end
     end
 
     def delete(id)
       if item = _find_item(id)
         item.destroy
-        puts "Item deleted."
+        puts "Deleted item ##{item.id}."
+        puts
+        list_progress
       end
     end
 
@@ -58,16 +109,16 @@ module Goldie
       elsif not flags.include? "all"
         items = Item.active
       end
-      if items.empty?
-        puts "No items."
-      else
-        puts "id\tweight\titem"
+
+      table = Terminal::Table.new(title: "Todo List", headings: %w(ID Progress Item)) do |t|
         items.each do |item|
+          progress = "%d / %d" % [item.weight_completed, item.weight]
+          progress_bar = _render_progress_bar(item.percent_done, 10)
           archived = item.archived? ? "[A] " : ""
-          done = item.done? ? "[X] " : "[ ] "
-          puts "#{item.id}\t#{item.weight}\t#{done}#{archived}#{item.title}"
+          t.add_row [item.id, progress, "#{progress_bar}  #{archived}#{item.title}"]
         end
       end
+      puts table
     end
 
     def progress
@@ -75,15 +126,15 @@ module Goldie
         puts "No active items."
       else
         total_weight = Item.active.sum(:weight)
-        checked_weight = Item.active.done.sum(:weight)
-        percent = checked_weight * 100 / total_weight
-        puts "[" + ("X" * (percent / 2)) + (" " * (50 - percent / 2)) + "] " + percent.to_s + "%"
+        total_weight_completed = Item.active.sum(:weight_completed)
+        percent = total_weight_completed * 100 / total_weight
+        puts "%s %s%%" % [_render_progress_bar(percent, 50), percent]
       end
     end
 
-    def progress_list
+    def list_progress
       if Item.active.empty?
-        puts "No active items."
+        puts "There are no active items to list."
       else
         list
         puts
@@ -91,6 +142,16 @@ module Goldie
       end
     end
 
+    def help
+      puts "Usage: goldie [command] [arg1] [arg2] ..."
+      puts
+      puts "Available commands:"
+      puts
+      COMMAND_LIST.each do |command, summary|
+        puts "  % -16s    %s" % [command, summary]
+      end
+    end
+
     def _find_item(id)
       if item = Item.where(id: id).first
         item
@@ -98,5 +159,18 @@ module Goldie
         puts "Couldn't find item with id '#{id}'."
       end
     end
+
+    def _display_errors(item)
+      item.errors.messages.each do |field, messages|
+        messages.each do |message|
+          puts "- #{field} #{message}"
+        end
+      end
+    end
+
+    def _render_progress_bar(percent, width)
+      progress = (percent * width / 100).to_i
+      ("\u2589" * progress).colored.green.bold + ("\u2589" * (width - progress)).colored.white.bold
+    end
   end
 end

data/lib/goldie/database.rb

@@ -11,7 +11,7 @@ module Goldie
         create_table :items do |t|
           t.string :title, null: false
           t.integer :weight, null: false, default: 1
-          t.boolean :done, null: false, default: false
+          t.integer :weight_completed, null: false, default: 0
           t.boolean :archived, null: false, default: false
           t.timestamps
         end

data/lib/goldie/item.rb

@@ -1,14 +1,47 @@
 module Goldie
   class Item < ActiveRecord::Base
-    attr_accessible :title, :weight, :done, :archived
+    attr_accessible :title, :weight, :weight_completed, :archived
 
     validates :title, presence: true
-    validates :weight, numericality: { only_integer: true }
+    validates :weight, :weight_completed, numericality: { only_integer: true }
+    validate :weight_completed_must_be_between_zero_and_weight
 
     scope :archived, where(archived: true)
     scope :active, where(archived: false)
-    scope :done, where(done: true)
-    scope :not_done, where(done: false)
+    scope :done, where("items.weight_completed == items.weight")
+    scope :not_done, where("items.weight_completed != items.weight")
     scope :latest, order("items.created_at DESC")
+
+    def done?
+      weight_completed == weight
+    end
+
+    def done!
+      update_attributes!(weight_completed: weight)
+    end
+
+    def not_done!
+      update_attributes!(weight_completed: 0)
+    end
+
+    def archive!
+      update_attributes!(:archived, true)
+    end
+
+    def unarchive!
+      update_attributes!(:archived, false)
+    end
+
+    def percent_done
+      weight_completed * 100.0 / weight
+    end
+
+    private
+
+    def weight_completed_must_be_between_zero_and_weight
+      unless (0..weight).include? weight_completed
+        errors.add(:weight_completed, "must be between zero and weight")
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goldie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: smart_colored
+  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'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +107,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Goldie is a simple command line todo list with a progress bar.
+description: Goldie is a command line todo list with lots of progress bars. Progress
+  is its middle name.
 email: jeremy.ruten@gmail.com
 executables:
 - goldie
@@ -86,6 +119,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - goldie.gemspec
+- README.md
 - bin/goldie
 - lib/goldie/commands.rb
 - lib/goldie/database.rb
@@ -115,5 +149,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A todo list with a progress bar.
+summary: A command line todo list.
 test_files: []