r2do 0.0.7 → 0.0.8

data/lib/r2do/category.rb

@@ -34,6 +34,10 @@ module R2do
       @current_task = nil
     end
 
+    def rename(name)
+      @name = name
+    end
+
     # Finds a task based on the description.
     #
     # @param [String] description the task description.
@@ -49,10 +53,14 @@ module R2do
     # @raise [Exceptions::TaskAlreadyExistsError] if task with same description is already present.
     # @return [void]
     def add(task)
-      raise ArgumentError unless not task.nil?
+      if task.nil?
+        raise ArgumentError
+      end
 
       duplicate = @tasks.find { |t| t.description == task.description }
-      raise TaskAlreadyExistsError unless duplicate.nil?
+      if duplicate
+        raise TaskAlreadyExistsError
+      end
 
       @tasks.push(task)
     end

data/lib/r2do/command.rb

@@ -16,13 +16,8 @@
 
 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
+  class Option < Command
+
 
     # Creates an instance of a Command
     #
@@ -31,15 +26,13 @@ module R2do
     # @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
+    def initialize(short, extended, description, callback)
+      super(short, extended, argument, description)
+
+      if callback.nil?
+        raise ArgumentError
+      end
+
       @callback = callback
     end
 
@@ -51,13 +44,6 @@ module R2do
       @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/commands/category_command.rb

@@ -0,0 +1,173 @@
+#
+#  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 CategoryCommand < Command
+
+      YES = "Y"
+
+      DISPLAY   = "--display"
+      DELETE    = "--delete"
+      EDIT      = "--edit"
+
+      def initialize(state)
+        super('c', 'category', 'Creates a new category.')
+
+        @state = state
+      end
+
+      # 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 execute(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?(EDIT)
+          require_selected_category()
+          edit_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
+
+      # Edit the current task.
+      #
+      # @param [Array] args the arguments passed to the app by the user.
+      # @return [void]
+      def edit_current_category(args)
+        UI.status("Are you sure you want to edit the category:")
+        UI.status("   #{@state.current_category.name}")
+        UI.new_line()
+        value = UI.input("Continue? [Yn]")
+        if value == YES
+          cat = @state.current_category
+
+          original_name = cat.name
+          name = UI.input("Enter new name:")
+
+          cat.rename(name)
+
+          @state.refresh(original_name, cat)
+          @state.modified = true
+
+          UI.status("The category as been modified.")
+        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)
+        #TODO: need to refatctor the code to remove the duplication (NowCommand)
+        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()
+          @state.modified = true
+
+          UI.status("Category '#{cat.name}' has been deleted.")
+        end
+      end
+
+      # Creates a new Category or selects an already existing one.
+      #
+      # @param [Array] args the argumets passed to the app by the user.
+      # @return [void]
+      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)
+        @state.modified = true
+
+        UI.status("Switched to #{extra}category '#{category_name}'")
+      end
+
+      # Ensures that a category is selected.
+      #
+      # @return [void]
+      def require_selected_category()
+        if @state.current_category.nil?
+          raise CategoryNotSelectedError, "This action requires a selected category."
+        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 category, create, edit, or delete. Defaults to the active category.
+
+      usage: r2do #{@extended} [NAME] [--edit] [--display] [--delete]
+
+      --edit                Edit the currently selected category
+      --display             Displays the details for the selected category
+      --delete              Delete the selected category
+
+        EOF
+      end
+
+    end
+
+  end
+
+end

data/lib/r2do/commands/command.rb

@@ -0,0 +1,64 @@
+#
+#  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
+    def initialize(short, extended, description)
+      if short.nil? or extended.nil? or description.nil?
+        raise ArgumentError
+      end
+
+      @short = short
+      @extended = extended
+      @description = description
+    end
+
+    # Executes the callback of this command
+    #
+    # @param [Array] args the collection of arguments
+    # @return [void]
+    def execute(args)
+      raise ScriptError, "Cannot call execute on an abstract command"
+    end
+
+    def help()
+      return "No help available for this command."
+    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/commands/display_categories.rb

@@ -0,0 +1,70 @@
+#
+#  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 DisplayCategoriesCommand < Command
+
+      def initialize(state)
+        super('l', 'list', 'Displays all the categories.')
+
+        @state = state
+      end
+
+      # Displays all the categories available
+      #
+      # @param [Array] args the arguments passed to the app by the user
+      # @return [void]
+      def execute(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
+
+      def help()
+        help = <<-EOF
+NAME
+       r2do #{@extended}
+
+SYNOPSIS
+       'r2do #{@extended}' or 'r2do #{@short}' are equivalent
+
+DESCRIPTION
+      The #{@extended} lets you Lists all the available categories in the application.
+
+      The current selected category is marked with and asterisk '*'
+
+      usage: r2do #{@extended}
+
+      e.g.
+
+        Category 1
+      * Category 2
+        Category 3
+
+        EOF
+      end
+
+    end
+
+  end
+
+end

data/lib/r2do/{handlers/handle_init.rb → commands/help_command.rb}

@@ -15,24 +15,31 @@
 #
 
 module R2do
-  module Handlers
-    module_function
-
-    # Initializes the applications and resets the datafile
-    #
-    # @param [Array] args the arguments passed to the app by the user
-    # @return [void]
-    def handle_init(args)
-      UI.status("Initialize new session?")
-      UI.new_line()
-      value = UI.input("Any previous session will be lost. Continue? [Yn]")
-      if value == YES
-        @state = State.new()
-        @modified = true
-        UI.status("Initialized a new session of r2do.")
-      else
-        UI.status("Continuing with current session.")
+  module Commands
+    class HelpCommand < Command
+
+      def initialize(cmd_list)
+        super('h', 'help', 'Shows the help for a given command')
+
+        @cmd_list = cmd_list
+      end
+
+      # Initializes the applications and resets the datafile
+      #
+      # @param [Array] args the arguments passed to the app by the user
+      # @return [void]
+      def execute(args)
+        argument = args[1]
+
+        cmd = @cmd_list.find { |c| c.short == argument or c.extended == argument }
+        if cmd.nil?
+          raise InvalidCommandError, "Invalid command. See 'r2do -h'"
+        end
+
+        UI.status(cmd.help())
       end
+
+
     end
 
   end

data/lib/r2do/commands/init_command.rb

@@ -0,0 +1,67 @@
+#
+#  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 InitCommand < Command
+
+      YES = "Y"
+
+      def initialize(state)
+        super('i', 'init', 'Initializes a new clean session.')
+
+        @state = state
+      end
+
+      # Initializes the applications and resets the datafile
+      #
+      # @param [Array] args the arguments passed to the app by the user
+      # @return [void]
+      def execute(args)
+        UI.status("Initialize new session?")
+        UI.new_line()
+        value = UI.input("Any previous session will be lost. Continue? [Yn]")
+        if value == YES
+          @state.reset()
+          @state.modified = true
+          UI.status("Initialized a new session of r2do.")
+        else
+          UI.status("Continuing with current session.")
+        end
+      end
+
+      def help()
+        help = <<-EOF
+NAME
+       r2do #{@extended}
+
+SYNOPSIS
+       'r2do #{@extended}' or 'r2do #{@short}' are equivalent
+
+DESCRIPTION
+
+      The #{@extended} command initializes a new session of the application. Any previously saved data is permanently lost.
+
+      usage: r2do #{@extended}
+
+        EOF
+      end
+
+    end
+
+  end
+
+end

data/lib/r2do/commands/now_command.rb

@@ -0,0 +1,71 @@
+#
+#  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 NowCommand < Command
+
+      def initialize(state)
+        super('n', 'now', 'Displays the information for the current category.')
+
+        @state = state
+      end
+
+      # 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 execute(args)
+        display_current_category(args)
+      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)
+        #TODO: need to refatctor the code to remove the duplication
+        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
+
+      def help()
+        help = <<-EOF
+NAME
+       r2do #{@extended}
+
+SYNOPSIS
+       'r2do #{@extended}' or 'r2do #{@short}' are equivalent
+
+DESCRIPTION
+      The #{@extended} lets view the current category and its tasks
+
+      usage: r2do #{@extended}
+
+        EOF
+      end
+
+    end
+
+  end
+
+end