hacer 0.0.3

data/README.rdoc

@@ -0,0 +1,59 @@
+= Hacer: A very basic todo-list library
+
+Author::  Dave Copeland (mailto:davetron5000 at g mail dot com)
+Copyright:: Copyright (c) 2010 by Dave Copeland
+License:: Distributes under the Apache License, see LICENSE.txt in the source distro
+
+* {Source on Github}[http://github.com/davetron5000/hacer]
+* RDoc[http://davetron5000.github.com/hacer]
+
+== Use
+
+Install if you need to:
+
+    gem install hacer
+
+Hacer provides a few basic features for managing a simple todolist:
+
+* <b>Create</b> - Create a new todo item
+* <b>Complete</b> - Compete a todo item
+* <b>List</b> - List todo items
+* <b>Clean</b> - Clear completed items from your todo list
+
+=== Bootstrapping
+
+The main entry into Hacer is Hacer::Todolist.  Create one by pointing it to the location where you want your todo list to live:
+
+    todo_list = Hacer::Todolist.new("todos")
+
+=== API
+
+The Todolist essentially manages a list of Hacer::Todo items
+
+    todo = todo_list.create("Mow the lawn")
+    todo_list.list # => [Todo(1,Mow the lawn)]
+
+    todo = todo_list.create("Take out the trash")
+    todo_list.list # => [Todo(1,Mow the lawn), Todo(2,Take out the trash)]
+
+    todo.complete(1)
+    todo_list.list # => [Todo(2,Take out the trash)]
+
+    todo_list.list(:all) # => [Todo(1,Mow the lawn,completed), Todo(2,Take out the trash)]
+
+    todo_list.clean!
+    todo_list.list(:all) # => [Todo(2,Take out the trash)]
+
+== Notes
+
+* API created using {README driven development}[http://tom.preston-werner.com/2010/08/23/readme-driven-development.html]
+* Code created entirely using Test-Driven Development
+
+== Development
+
+    gem install bundler
+    bundle install
+    rake test
+    rake rcov
+
+

data/lib/hacer.rb

@@ -0,0 +1,134 @@
+require 'yaml'
+
+# See Hacer::Todolist
+module Hacer
+  # A todo list manages a list of Todo items.  It holds all Todo items, even completed ones, until you
+  # call clean!
+  class Todolist
+    # Create a new Todolist stored in the given filename
+    #
+    # [+filename+] String containing the name of the file to create.  If the file exists, it will be parsed as an Hacer todolist.  If this isn't possible, an ArgumentError will be raised
+    def initialize(filename)
+      @filename = filename
+      if File.exists?(@filename)
+        @todos = File.open(@filename) { |file| YAML.load(file) }
+        raise ArgumentError.new("#{@filename} doesn't appear to be an hacer todo list") unless valid_todolist?
+      else
+        @todos = []
+        save_todos
+      end
+      todo_with_biggest_id = @todos.max { |a,b| a.todo_id <=> b.todo_id }
+      @next_id  = todo_with_biggest_id.nil? ? 0 : todo_with_biggest_id.todo_id + 1
+    end
+
+    # Create a new todo and store it in this list
+    #
+    # [+todo_text+] String containing the text of the todo item
+    #
+    # Returns the Todo item created
+    def create(todo_text)
+      todo = TodoInternal.new(todo_text,next_id)
+      @todos << todo
+      save_todos
+      todo
+    end
+
+    # Completes this todo item
+    #
+    # [+todo+] Todo to complete
+    def complete(todo)
+      todo.complete
+      save_todos
+    end
+
+    # Cleans out any completed todos.  This cannot be undone an the completed todos will be lost forever
+    def clean!
+      @todos = self.list(:incomplete)
+      save_todos
+    end
+
+    # Return all todos in this Todolist as an Array of Todo
+    #
+    # [+show+] Symbol representing which todos to return:
+    #          [+:incomplete+] show only those not completed
+    #          [+:all+] show everything
+    def list(show=:incomplete)
+      case show
+      when :incomplete then @todos.select { |todo| !todo.completed? }
+      when :all then @todos
+      else
+        raise ArgumentError.new("Only :incomplete or :all are allowed")
+      end
+    end
+
+    # Returns the size of the todolist as an Int.
+    #
+    # [+show+] same as for #list
+    def size(show=:incomplete)
+      return list(show).size
+    end
+
+    private
+
+    # Saves the todos into the filename
+    def save_todos
+      File.open(@filename,'w') do |file|
+        YAML.dump(@todos,file)
+      end
+    end
+
+    # Returns true if what we parsed into @todos is a valid todo list
+    def valid_todolist?
+      return false unless @todos.kind_of? Array
+      @todos.each do |todo|
+        return false unless todo.kind_of? Todo
+      end
+      true
+    end
+
+    @next_id = 0
+    def next_id
+      next_id = @next_id
+      @next_id += 1
+      next_id
+    end
+  end
+
+  class Todo
+    # Text of the todo
+    attr_reader :text
+    # id of the todo
+    attr_reader :todo_id
+
+    # Returns true if this todo has been completed
+    def completed?; @completed; end
+
+    # Do not create Todos this way, use the Todolist instead
+    def initialize
+      raise "Use the Todolist to create todos"
+    end
+
+    def to_s
+      s = "Todo(#{todo_id},#{text}"
+      s += ",completed" if completed?
+      s + ")"
+    end
+  end
+
+  # Internal Todo subclass for use only by Todolist; clients of Todolist should program
+  # against Todo :nodoc:
+  class TodoInternal < Todo #:nodoc:
+    
+    # Create a new todo
+    #
+    # [+text+] Text for this todo, e.g. "Take out the trash"
+    # [+todo_id+] the identifier for this todo
+    def initialize(text,todo_id)
+      @todo_id = todo_id
+      @text = text
+      @completed = false
+    end
+
+    def complete; @completed = true; end
+  end
+end

data/lib/hacer_version.rb

@@ -0,0 +1,3 @@
+module Hacer
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: hacer
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- David Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-12 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: This is an extremely simple API for creating and managing todo lists.  The todo list is a simple YAML file that stores a list of todo items that can be completed/checked off
+email: davidcopeland@naildrivin5.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/hacer.rb
+- lib/hacer_version.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://davetron5000.github.com/hacer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Hacer, the simple todo list API
+- --main
+- README.rdoc
+- -R
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hacer
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A very simple todo list API
+test_files: []
+