r2do 0.0.7 → 0.0.8

data/lib/r2do/commands/task_command.rb

@@ -0,0 +1,186 @@
+#
+#  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 Commands
+    class TaskCommand < Command
+
+      YES = "Y"
+
+      #options
+      COMPLETED = "--done"
+      DISPLAY   = "--display"
+      DELETE    = "--delete"
+      EDIT      = "--edit"
+
+      def initialize(state)
+        super('t', 'task', 'Adds a new task to the current category.')
+
+        @state = state
+      end
+
+      # Creates a new task or makes a task current in the current category if a task 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 task
+      # @return [void]
+      def execute(args)
+        if args.length < 2
+          raise ArgumentError, "The 'task' command requires additional arguments."
+        end
+
+        if @state.current_category.nil?
+          raise CategoryNotSelectedError, "You need to select a category to create a new task."
+        end
+
+        option = args[1]
+
+        if option.eql?(DISPLAY)
+          require_selected_task()
+          show_current_task(args)
+        elsif option.eql?(EDIT)
+          require_selected_task()
+          edit_current_task(args)
+        elsif option.eql?(COMPLETED)
+          require_selected_task()
+          mark_as_complete(args)
+        elsif option.eql?(DELETE)
+          require_selected_task()
+          delete_task(args)
+        elsif option.start_with?("--")
+          raise InvalidOptionError, "Invalid argument for the command. See 'r2do -h'."
+        else
+          parse_task(args)
+        end
+      end
+
+      # Edit the current task.
+      #
+      # @param [Array] args the arguments passed to the app by the user.
+      # @return [void]
+      def edit_current_task(args)
+        UI.status("Are you sure you want to edit the task:")
+        UI.status("   #{@state.current_category.current_task.description}")
+        UI.new_line()
+        value = UI.input("Continue? [Yn]")
+        if value == YES
+          desc = UI.input("Enter new description:")
+          task = @state.current_category.current_task
+          task.rename(desc)
+          @state.modified = true
+
+          UI.status("The task as been modified.")
+        end
+      end
+
+      # Delete the currently selected task.
+      #
+      # @param [Array] args the arguments passed to the app by the user.
+      # @return [void]
+      def delete_task(args)
+        UI.status("Are you sure you want to delete the task:")
+        UI.status("   #{@state.current_category.current_task.description}")
+        UI.new_line()
+        value = UI.input("This action cannot be undone. Continue? [Yn]")
+        if value == YES
+          task = @state.current_category.current_task
+          @state.current_category.remove(task)
+          @state.current_category.clear_current_task()
+          @state.modified = true
+
+          UI.status("Task '#{task.description}' has been deleted.")
+        end
+      end
+
+      # Displays the information of the currently selected task.
+      #
+      # @param [Array] args the arguments passed to the app by the user.
+      # @return [void]
+      def show_current_task(args)
+        task = @state.current_category.current_task
+        UI.status(task.display())
+      end
+
+      # Marks a task as completed.
+      #
+      # @param [Array] args the arguments passed to the app by the user.
+      # @return [void]
+      def mark_as_complete(args)
+        task = @state.current_category.current_task
+        task.completed()
+        @state.modified = true
+
+        UI.status("Task '%s' has been marked as completed." % task.description)
+      end
+
+      # Creates a new task or select an already existing one.
+      #
+      # @param [Array] args the arguments passed to the app by the user.
+      # @return [void]
+      def parse_task(args)
+        extra = ''
+        task_description = args[1]
+        task = @state.current_category.find_by_description(task_description)
+        if task.nil?
+          task = Task.new(task_description)
+          @state.current_category.add(task)
+
+          UI.status("Created new task.")
+          UI.new_line()
+        end
+
+        @state.current_category.set_current(task)
+        @state.modified = true
+
+        UI.status("Selected task '#{task_description}'")
+      end
+
+      # Checks that a task is currently selected.
+      #
+      # @return [void]
+      def require_selected_task()
+        if @state.current_category.current_task.nil?
+          raise TaskNotSelectedError, "This action requires a selected task."
+        end
+      end
+
+
+      def help()
+        help = <<-EOF
+NAME
+       r2do #{@extended}
+
+SYNOPSIS
+       'r2do #{@extended}' or 'r2do #{@short}' are equivalent
+
+DESCRIPTION
+      The #{@extended} lets you interact with a task, create, edit, or delete. Defaults to the active task.
+
+      usage: r2do #{@extended} [NAME] [--edit] [--display] [--delete]
+
+      --edit                Edit the currently selected task
+      --display             Displays the details for the selected task
+      --delete              Delete the selected task
+
+        EOF
+      end
+
+    end
+
+  end
+
+end

data/lib/r2do/exceptions.rb

@@ -24,4 +24,6 @@ module R2do
   class CategoryNotFoundError < Exception; end;
   class CategoryAlreadyExistsError < Exception; end;
   class CategoryNotSelectedError < Exception; end;
+
+  class InvalidCommandError < Exception; end;
 end

data/lib/r2do/option.rb

@@ -0,0 +1,51 @@
+#
+#  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 Commands
+
+    class Option < Command
+
+      # 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, description, callback)
+        super(short, extended, description)
+
+        if callback.nil?
+          raise ArgumentError
+        end
+
+        @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
+
+    end
+
+  end
+
+end

data/lib/r2do/state.rb

@@ -21,12 +21,24 @@ module R2do
   	attr_accessor :categories
     # @return [Category] the current category the user is working on.
     attr_accessor :current_category
+    # @return [bool] true if the state has been modified
+    attr_accessor :modified
 
     # Creates a new instance of the State
     #
     def initialize()
+      init()
+    end
+
+    def init()
       @categories = Hash.new
       @current_category = nil
+      @modified = false
+    end
+
+    def reset()
+      init()
+      @modified = true
     end
 
     # Sets a Category as the current one.
@@ -68,6 +80,12 @@ module R2do
       @categories[category.name] = category
     end
 
+
+    def refresh(original_name, category)
+      @categories.delete(original_name) { raise CategoryNotFoundError.new() }
+      @categories[category.name] = category
+    end
+
     # Removes the category from the state.
     #
     # @param [Category] category the category to remove.

data/lib/r2do/task.rb

@@ -24,10 +24,16 @@ module R2do
     # @return [DateTime] the date and time of creation
     attr_accessor :date_created
 
+    MAX_LENGTH = 30
+
     # Creates a new instance of a Task
     #
     # @param [String] desctiption the description for this task
     def initialize(description)
+      if description.length > MAX_LENGTH
+        raise ArgumentError, "A task description has to be less than 30 characters."
+      end
+
       @description = description
       @done = false
       @date_created = DateTime.now

data/lib/r2do/utility.rb

@@ -15,7 +15,6 @@
 #
 
 module R2do
-
   module Utility
     module_function
 

data/lib/r2do/version.rb

@@ -15,5 +15,5 @@
 #
 
 module R2do
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/r2do.rb

@@ -16,17 +16,20 @@
 
 require 'yaml'
 
+require 'r2do/commands/command'
 require 'r2do/ui'
 require 'r2do/category'
 require 'r2do/task'
 require 'r2do/exceptions'
-require 'r2do/command'
+require 'r2do/option'
 require 'r2do/state'
 require 'r2do/version'
-require 'r2do/handlers/handle_category'
-require 'r2do/handlers/handle_task'
-require 'r2do/handlers/handle_init'
-require 'r2do/handlers/handle_categories'
+require 'r2do/commands/now_command'
+require 'r2do/commands/category_command'
+require 'r2do/commands/task_command'
+require 'r2do/commands/init_command'
+require 'r2do/commands/display_categories'
+require 'r2do/commands/help_command'
 require 'r2do/utility'
 
 
@@ -34,18 +37,18 @@ module R2do
   class App
     include R2do
     include Utility
-    include Handlers
+    include Commands
 
     # Creates an instance of the application.
     #
     # @param [Array] args the command line args.
     def initialize(args)
       @args = args
-      @commands = create_commands()
-      @modified = false
-      @file_name = ".r2do.yml"
 
+      @file_name = ".r2do.yml"
       @state = load_state(@file_name)
+
+      @commands = create_commands()
     end
 
     # Evaluates the command passed by the user and calls the corresponding application command.
@@ -74,7 +77,7 @@ module R2do
     #
     # @return [void]
     def save()
-      if @modified
+      if @state.modified
         save_state(@file_name, @state)
       end
     end
@@ -86,15 +89,16 @@ module R2do
     # @return [Array] the collection of commands.
     def create_commands()
       cmd_list = Array.new
-      cmd_list << Command.new('i', 'initialize', nil, 'Initializes a new clean session.', method(:handle_init))
-      cmd_list << Command.new('c', 'category', 'NAME', 'Creates a new category', method(:handle_category))
-      cmd_list << Command.new('t', 'task', 'NAME', 'Adds a new task to the current category.', method(:handle_task))
-      cmd_list << Command.new('d', 'display', nil, 'Displays all the categories', method(:handle_categories))
-      cmd_list << Command.new('n', 'now', nil, 'Displays the information for the current category', method(:display_current_category))
-      cmd_list << Command.new('h', 'help', nil, 'Displays the help for a command', method(:handle_help))
-
-      cmd_list << Command.new('-v', '--version', nil, 'Prints the application version.', method(:show_version))
-      cmd_list << Command.new('-h', '--help', nil, 'You are looking at it.', method(:show_help))
+      cmd_list << InitCommand.new(@state)
+      cmd_list << CategoryCommand.new(@state)
+      cmd_list << TaskCommand.new(@state)
+      cmd_list << DisplayCategoriesCommand.new(@state)
+      cmd_list << NowCommand.new(@state)
+
+      cmd_list << HelpCommand.new(Array.new(cmd_list))
+
+      cmd_list << Option.new('-v', '--version', 'Prints the application version.', method(:show_version))
+      cmd_list << Option.new('-h', '--help', 'You are looking at it.', method(:show_help))
 
       cmd_list
     end

data/r2do.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/r2do/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["cgiacomi"]
   gem.email         = ["christiangiacomi@gmail.com"]
-  gem.description   = %q{A simple todo gem}
-  gem.summary       = %q{A simple todo gem}
+  gem.summary       = %q{r2do is a simple todo gem for the CLI}
+  gem.description   = %q{r2do is a simple todo gem which allows you to create Tasks and group them by Category. r2do is meant for the CLI. }
   gem.homepage      = "https://github.com/cgiacomi/r2do"
 
   gem.add_development_dependency "rspec"
@@ -20,4 +20,6 @@ Gem::Specification.new do |gem|
   gem.name          = "r2do"
   gem.require_paths = ["lib"]
   gem.version       = R2do::VERSION
+  gem.license       = "Apache v2"
+  gem.post_install_message = "Thanks for installing r2do."
 end

data/spec/r2do/option_spec.rb

@@ -0,0 +1,87 @@
+#
+#  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.
+#
+
+require 'spec_helper'
+
+module R2do
+  module Commands
+
+    describe Option do
+      before(:each) do
+        @callback_invoked = false
+      end
+
+      def callback(args)
+        @callback_invoked = true
+      end
+
+      describe "#new" do
+        context "valid arguments" do
+          it "returns an instance of Option" do
+            command = Option.new('c', 'category', 'description for this command', method(:callback))
+            command.should be_an_instance_of Option
+          end
+        end
+
+        context "null args" do
+          it "raises an error if the swtich is null" do
+            expect{ Option.new(nil, 'category', 'description for this command', method(:callback)) }.to raise_error(ArgumentError)
+          end
+
+          it "raises an error if the name is null" do
+            expect{ Option.new('c', nil, 'description for this command', method(:callback)) }.to raise_error(ArgumentError)
+          end
+
+          it "raises an error if the description is null" do
+            expect{ Option.new('c', 'category', nil, method(:callback)) }.to raise_error(ArgumentError)
+          end
+
+          it "raises an error if the callback is null" do
+            expect{ Option.new('c', 'category', 'desctiption', nil) }.to raise_error(ArgumentError)
+          end
+        end
+      end
+
+      describe "#to_s" do
+        it "returns the correct representation" do
+          short = 'c'
+          extended = 'category'
+          description = 'description for this command'
+
+          result = "%2s, %-10s \t# %s" % [short, extended, description]
+          command = Option.new(short, extended, description, method(:callback))
+          command.to_s.should eql result
+        end
+      end
+
+      describe "#execute" do
+        it "exectutes the callback" do
+          @callback_invoked.should eql false
+
+          short = 'c'
+          extended = 'category'
+          description = 'description for this command'
+          args = Array.new
+          command = Option.new(short, extended, description, method(:callback))
+          command.execute(args)
+
+          @callback_invoked.should eql true
+        end
+      end
+    end
+  end
+
+end

data/spec/r2do/task_spec.rb

@@ -36,6 +36,20 @@ module R2do
           expect { Task.new }.to raise_error(ArgumentError)
         end
       end
+
+      context "with a length of more than 30 characters" do
+        it "raises and exception" do
+          name = "a"*31
+          expect { Task.new(name) }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "with a length of 30 chars" do
+        it "returns a valid instance" do
+          name = "a"*30
+          Task.new(name)
+        end
+      end
     end
 
     describe "#description" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: r2do
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-22 00:00:00.000000000 Z
+date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,7 +91,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple todo gem
+description: ! 'r2do is a simple todo gem which allows you to create Tasks and group
+  them by Category. r2do is meant for the CLI. '
 email:
 - christiangiacomi@gmail.com
 executables:
@@ -109,11 +110,15 @@ files:
 - lib/r2do.rb
 - lib/r2do/category.rb
 - lib/r2do/command.rb
+- lib/r2do/commands/category_command.rb
+- lib/r2do/commands/command.rb
+- lib/r2do/commands/display_categories.rb
+- lib/r2do/commands/help_command.rb
+- lib/r2do/commands/init_command.rb
+- lib/r2do/commands/now_command.rb
+- lib/r2do/commands/task_command.rb
 - lib/r2do/exceptions.rb
-- lib/r2do/handlers/handle_categories.rb
-- lib/r2do/handlers/handle_category.rb
-- lib/r2do/handlers/handle_init.rb
-- lib/r2do/handlers/handle_task.rb
+- lib/r2do/option.rb
 - lib/r2do/state.rb
 - lib/r2do/task.rb
 - lib/r2do/ui.rb
@@ -121,14 +126,15 @@ files:
 - lib/r2do/version.rb
 - r2do.gemspec
 - spec/r2do/category_spec.rb
-- spec/r2do/command_spec.rb
 - spec/r2do/controller_spec.rb
+- spec/r2do/option_spec.rb
 - spec/r2do/r2do_spec.rb
 - spec/r2do/task_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cgiacomi/r2do
-licenses: []
-post_install_message: 
+licenses:
+- Apache v2
+post_install_message: Thanks for installing r2do.
 rdoc_options: []
 require_paths:
 - lib
@@ -140,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -972365083019823289
+      hash: 755238635905797132
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,17 +155,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -972365083019823289
+      hash: 755238635905797132
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A simple todo gem
+summary: r2do is a simple todo gem for the CLI
 test_files:
 - spec/r2do/category_spec.rb
-- spec/r2do/command_spec.rb
 - spec/r2do/controller_spec.rb
+- spec/r2do/option_spec.rb
 - spec/r2do/r2do_spec.rb
 - spec/r2do/task_spec.rb
 - spec/spec_helper.rb

data/lib/r2do/handlers/handle_categories.rb

@@ -1,52 +0,0 @@
-#
-#  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