r2do 0.0.6

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags
+*.swp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*.lock
+db/*.sqlite3
+log/*.log
+.DS_Store
+
+r2do_data.yml
+coverage

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,112 @@
+# r2do [![Build Status](https://secure.travis-ci.org/cgiacomi/r2do.png?branch=master)](http://travis-ci.org/cgiacomi/r2do) [![Dependency Status](https://gemnasium.com/cgiacomi/r2do.png)](http://gemnasium.com/cgiacomi/r2do) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/cgiacomi/r2do)
+
+r2do is a simple todo gem to help you remember anything that comes to mind. r2do can be used for normal daily tasks or for your ruby development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'r2do'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install r2do
+
+## Usage
+
+r2do is still in early development and there are many things missing at present.
+
+As r2do evolves this usage section will reflect the new changes.
+
+At present this is what is available.
+
+
+To initialize or reset the application:
+
+    r2do initialize
+
+
+### Category
+
+To create a new category or to switch to an existing category:
+
+    r2do category 'My new category'
+
+To display the information of the current category:
+
+    r2do category --display
+
+    # or the shortcut
+
+    r2do now
+
+To permanently delete a Category and its contents:
+
+    r2do category --delete
+
+To list all existing categories:
+
+    r2do display
+
+
+### Task
+
+To create a new Task or to select an existing one:
+
+    r2do task MyTask
+
+To view the information regarding a Task:
+
+    r2do task --display
+
+To complete a Task:
+
+    r2do task --done
+
+To permanently delete a Task:
+
+    r2do task --delete
+
+
+### Short command format
+
+All commands support a short format, for example:
+
+    r2do category 'My new category'
+
+    #can be written
+
+    r2do c 'My new category'
+
+To see all the available commands:
+
+    r2do --help
+
+
+## What is missing?
+
+There are many features presently missing from r2do, which will be implemented in future versions but there is one thing which must be noted here.
+
+1) The ability to edit a Category or a Task is lacking at present. It is the top priority, but please note that it is missing.
+
+If you need to edit a Task you can delete the old one and re-create it.
+The same goes for a Category, although this is more annoying as you will loose your Tasks when you delete a Category.
+
+2) The ability to move a Task from one Category to another is also missing.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+r2do is released under the Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/r2do

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'r2do'
+
+app = R2do::App.new(ARGV)
+app.run()
+app.save()

data/lib/r2do/category.rb

@@ -0,0 +1,105 @@
+#
+#  Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+module R2do
+
+  class Category
+    # @return [String] the name of this category.
+    attr_accessor :name
+    # @return [Array] the tasks this category contains.
+    attr_accessor :tasks
+    # @return [Task] the current task
+    attr_accessor :current_task
+
+
+    # Creates a new instance of a Category
+    #
+    # @param [String] name the name for this category
+    def initialize(name)
+      @name = name
+      @tasks = Array.new
+      @current_task = nil
+    end
+
+    # Finds a task based on the description.
+    #
+    # @param [String] description the task description.
+    # @return [Task] the task identified by description.
+    def find_by_description(description)
+      @tasks.find { |t| t.description == description }
+    end
+
+    # Adds the object into the specific Category.
+    #
+    # @param [Task] task the task to add.
+    # @raise [ArgumentError] if task is nil.
+    # @raise [Exceptions::TaskAlreadyExistsError] if task with same description is already present.
+    # @return [void]
+    def add(task)
+      raise ArgumentError unless not task.nil?
+
+      duplicate = @tasks.find { |t| t.description == task.description }
+      raise TaskAlreadyExistsError unless duplicate.nil?
+
+      @tasks.push(task)
+    end
+
+    # Sets a Task as the current one.
+    #
+    # @param [Task] category the category to be set as current.
+    # @return [void]
+    def set_current(task)
+      @current_task = task
+    end
+
+    # Clears the current task
+    #
+    # @return [void]
+    def clear_current_task()
+      @current_task = nil
+    end
+
+    # Removes the object from the specific Category.
+    #
+    # @param [Task] task the task to remove.
+    # @raise [Exceptions::TaskNotFoundError] if task is not found.
+    # @return [void]
+    def remove(task)
+      @tasks.delete(task) { raise TaskNotFoundError.new() }
+    end
+
+    # Returns a string representation of this Category
+    #
+    # @return [String] the representation of this Category
+    def to_s()
+      count = 0
+      result = StringIO.new
+
+      result << "%s:\n\n" % [@name]
+      result << "    %-30s     %s\n" % ["Task", "Completed"]
+      result << "    " << "-"*51
+      result << "\n"
+
+      @tasks.each do | task |
+        count += 1
+        result << "    %s\n" % task
+      end
+
+      return result.string
+    end
+  end
+
+end

data/lib/r2do/command.rb

@@ -0,0 +1,63 @@
+#
+#  Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+module R2do
+
+  class Command
+    # @return [String] the value for the command switch.
+    attr_reader :short
+    # @return [String] the name of this command.
+    attr_reader :extended
+    # @return [String] the description for the command.
+    attr_reader :description
+
+    # Creates an instance of a Command
+    #
+    # @param [String] short the short option name for this command
+    # @param [String] extended the full option name for this command
+    # @param [String] argument the optional argument for commands that have arguments
+    # @param [String] description the command's description
+    # @param [callback] callback the callback method for this command
+    def initialize(short, extended, argument, description, callback)
+      raise ArgumentError unless not short.nil? and
+                                  not extended.nil? and
+                                  not description.nil? and
+                                  not callback.nil?
+
+      @short = short
+      @extended = extended
+      @description = description
+      @callback = callback
+    end
+
+    # Executes the callback of this command
+    #
+    # @param [Array] args the collection of arguments
+    # @return [void]
+    def execute(args)
+      @callback.call(args)
+    end
+
+    # Returns a string representation of this Command
+    #
+    # @return [String] the representation of this Command
+    def to_s()
+      return "%2s, %-10s \t# %s" % [@short, @extended, @description]
+    end
+
+  end
+
+end

data/lib/r2do/exceptions.rb

@@ -0,0 +1,27 @@
+#
+#  Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+module R2do
+  class InvalidOptionError < Exception; end;
+
+  class TaskNotFoundError < Exception; end;
+  class TaskAlreadyExistsError < Exception; end;
+  class TaskNotSelectedError < Exception; end;
+
+  class CategoryNotFoundError < Exception; end;
+  class CategoryAlreadyExistsError < Exception; end;
+  class CategoryNotSelectedError < Exception; end;
+end

data/lib/r2do/handlers/handle_categories.rb

@@ -0,0 +1,52 @@
+#
+#  Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+module R2do
+  module Handlers
+    module_function
+
+    # Displays all the categories available
+    #
+    # @param [Array] args the arguments passed to the app by the user
+    # @return [void]
+    def handle_categories(args)
+      if @state.categories.empty?
+          UI.status("No categories to display")
+      else
+        @state.categories.each do |key, value|
+          current = (value == @state.current_category && "*") || ' '
+          UI.status("#{current} #{value.name}")
+        end
+      end
+    end
+
+    # Displays the help for a command
+    #
+    # @param [Array] args the arguments passed to the app by the user
+    # @return [void]
+    def handle_help(args)
+      if args.length < 2
+        show_help(args)
+        return
+      end
+
+      command = args[1]
+      UI.status("TODO: show the help for command '%s'" % command)
+    end
+
+  end
+
+end

data/lib/r2do/handlers/handle_category.rb

@@ -0,0 +1,106 @@
+#
+#  Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+module R2do
+  module Handlers
+    module_function
+
+    # Creates a new category or makes a category current in the state if a category with the
+    # same name already exists
+    #
+    # @param [Array] args the arguments passed to the app by the user
+    # @raise [ArgumentError] if the command does not contain a name for the category
+    # @return [void]
+    def handle_category(args)
+      if args.length < 2
+        raise ArgumentError, "The 'category' command requires additional arguments."
+      end
+
+      option = args[1]
+
+      if option.eql?(DISPLAY)
+        display_current_category(args)
+      elsif option.eql?(DELETE)
+        require_selected_category()
+        delete_category(args)
+      elsif option.start_with?("--")
+        raise InvalidOptionError
+      else
+        parse_category(args)
+      end
+    end
+
+    # Shows the detailed information for the current category, including the tasks contained
+    #
+    # @param [Array] args the arguments passed to the app by the user
+    # @return [void]
+    def display_current_category(args)
+      if not @state.current_category
+        UI.status("No category is currently selected.")
+      else
+        UI.status(@state.current_category.to_s)
+        UI.new_line()
+      end
+    end
+
+    # Deletes the currently selected category
+    #
+    # @param [Array] args the argumets passed to the app by the user
+    # @return [void]
+    def delete_category(args)
+      UI.status("Are you sure you want to delete the category:")
+      UI.status("   #{@state.current_category.name}")
+      UI.new_line()
+      UI.status("All tasks contained in this category will be lost.")
+      value = UI.input("This action cannot be undone. Continue? [Yn]")
+      if value == YES
+        cat = @state.current_category
+        @state.remove(cat)
+        @state.clear_current_category()
+        @modified = true
+
+        UI.status("Category '#{cat.name}' has been deleted.")
+      end
+    end
+
+
+    def parse_category(args)
+      extra = ''
+      category_name = args[1]
+      if @state.contains?(category_name)
+        cat = @state.get(category_name)
+      else
+        extra = 'new '
+        cat = Category.new(category_name)
+        @state.add(cat)
+      end
+
+      @state.set_current(cat)
+      @modified = true
+
+      UI.status("Switched to #{extra}category '#{category_name}'")
+    end
+
+
+    def require_selected_category()
+      if not @state.current_category
+        raise CategoryNotSelectedError, "This action requires a selected category."
+      end
+    end
+
+  end
+
+end