r2do 0.0.6

data/lib/r2do/handlers/handle_current.rb

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

data/lib/r2do/handlers/handle_init.rb

@@ -0,0 +1,40 @@
+#
+#  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
+
+    # 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.")
+      end
+    end
+
+  end
+
+end

data/lib/r2do/handlers/handle_task.rb

@@ -0,0 +1,122 @@
+#
+#  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
+
+    YES = "Y"
+
+    #options
+    COMPLETED = "--done"
+    DISPLAY   = "--display"
+    DELETE    = "--delete"
+
+    # 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 handle_task(args)
+      if args.length < 2
+        raise ArgumentError, "The 'task' command requires additional arguments."
+      end
+
+      if not @state.current_category
+        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?(COMPLETED)
+        require_selected_task()
+        mark_as_complete(args)
+      elsif option.eql?(DELETE)
+        require_selected_task()
+        delete_task(args)
+      elsif option.start_with?("--")
+        raise InvalidOptionError
+      else
+        parse_task(args)
+      end
+    end
+
+
+    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()
+        @modified = true
+
+        UI.status("Task '#{task.description}' has been deleted.")
+      end
+    end
+
+
+    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()
+      @modified = true
+
+      UI.status("Task '%s' has been marked as completed." % task.description)
+    end
+
+
+    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)
+      @modified = true
+
+      UI.status("Selected task '#{task_description}'")
+    end
+
+    def require_selected_task()
+      if not @state.current_category.current_task
+        raise TaskNotSelectedError, "This action requires a selected task."
+      end
+    end
+
+  end
+
+end

data/lib/r2do/state.rb

@@ -0,0 +1,82 @@
+#
+#  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 State
+    # @return [Hash] the collection of categories created by the user.
+  	attr_accessor :categories
+    # @return [Category] the current category the user is working on.
+    attr_accessor :current_category
+
+    # Creates a new instance of the State
+    #
+    def initialize()
+      @categories = Hash.new
+      @current_category = nil
+    end
+
+    # Sets a Category as the current one.
+    #
+    # @param [Category] category the category to be set as current.
+    # @return [void]
+    def set_current(category)
+      @current_category = category
+    end
+
+    # Clears the current category
+    #
+    # return [void]
+    def clear_current_category()
+      @current_category = nil
+    end
+
+    # Checks if a category with a specific name already exists.
+    #
+    # @param [String] category_name the name of the category to check.
+    # @return [bool] true if the category is already present.
+    def contains?(category_name)
+      @categories.has_key?(category_name)
+    end
+
+    # Retrieves a specific Category.
+    #
+    # @param [String] category_name the name of the category to retrieve.
+    # @return [Category] the category identified by category_name.
+    def get(category_name)
+      @categories[category_name]
+    end
+
+    # Adds a category.
+    #
+    # @param [Category] category the category to add.
+    # @return [void]
+    def add(category)
+      @categories[category.name] = category
+    end
+
+    # Removes the category from the state.
+    #
+    # @param [Category] category the category to remove.
+    # @raise [Exceptions::CategoryNotFoundError] if category is not found.
+    # @return [void]
+    def remove(category)
+      @categories.delete(category.name) { raise CategoryNotFoundError.new() }
+    end
+
+  end
+
+end

data/lib/r2do/task.rb

@@ -0,0 +1,91 @@
+#
+#  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 Task
+    # @return [String] the description for this task.
+    attr_accessor :description
+    # @return [DateTime] the date and time of completion.
+    attr_accessor :date_done
+    # @return [DateTime] the date and time of creation
+    attr_accessor :date_created
+
+    # Creates a new instance of a Task
+    #
+    # @param [String] desctiption the description for this task
+    def initialize(description)
+      @description = description
+      @done = false
+      @date_created = DateTime.now
+      @date_done = nil
+    end
+
+    # Gets the completed status of the specific task.
+    #
+    # @return [bool] true if the task is completed.
+    def done?()
+      return @done
+    end
+
+    # Flags the specific task as completed.
+    #
+    # @return [DateTime] the date and time of completion.
+    def completed()
+      @done = true
+      @date_done = DateTime.now
+    end
+
+    # Returns a string representation of this Task
+    #
+    # @return [String] the representation of this Task
+    def to_s()
+      completed = ' '
+      date = ''
+
+      if done?
+        completed = 'x'
+        date = format_date(@date_done)
+      end
+
+      return "[%s] %-30s %s" % [completed, @description, date]
+    end
+
+    def display()
+      date = format_date(@date_created)
+
+      result = StringIO.new
+
+      result << "Selected task:\n"
+      result << "   %s\n\n" % @description
+      result << "Created:\n"
+      result << "   %s" % date
+
+      if done?
+        result << "\nCompleted:\n"
+        result << "   %s" % format_date(@date_done)
+      end
+
+      return result.string
+    end
+
+
+    def format_date(date)
+      date.strftime('%a %b %e, %Y')
+    end
+  end
+
+end

data/lib/r2do/ui.rb

@@ -0,0 +1,47 @@
+#
+#  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 UI
+
+    # Displays a status message to the user
+    #
+    # @param [String] message the message to display to the user
+    # @return [void]
+    def self.status(message)
+      puts message
+    end
+
+    # Adds a new empty line on the display
+    #
+    # @return [void]
+    def self.new_line()
+      puts
+    end
+
+    # Accepts user input after displaying a message
+    #
+    # @return [String] the value the user inserted
+    def self.input(message)
+      print "#{message}  "
+      $stdout.flush
+      value = $stdin.gets.chomp
+    end
+
+  end
+
+end

data/lib/r2do/utility.rb

@@ -0,0 +1,89 @@
+#
+#  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 Utility
+    module_function
+
+    # Loads the data file and deserializes the State.
+    #
+    # @param [String] file_name the name of the file to load.
+    # @return [State] the application State.
+    def load_state(file_name)
+      file_path = calculate_path(file_name)
+
+      if File.exists?(file_path)
+        file = File.open(file_path, "rb")
+        state = YAML::load(file.read)
+      else
+        state = State.new
+      end
+
+      state
+    end
+
+    # Saves the data file and serializes the State.
+    #
+    # @param [String] file_name the name of the file to save.
+    # @param [State] the application state to save.
+    # @return [void]
+    def save_state(file_name, state)
+      file_path = calculate_path(file_name)
+
+      file = File.new(file_path, 'w')
+      file.write(YAML.dump(state))
+      file.close()
+    end
+
+    # Calculates the path location for the data file.
+    #
+    # @param [String] file_name the name of the file to load.
+    # @return [String] the full destination path including the filename.
+    def calculate_path(file_name)
+      data_path = File.expand_path("~/")
+      file_path = File.join(data_path, file_name)
+    end
+
+    # Show the help command
+    #
+    # @param [Array] args the list of args the user passed the application
+    # @return [void]
+    def show_help(args)
+      UI.status("Usage:")
+      UI.status("    r2do <command> [<args>] [options]")
+      UI.new_line()
+      UI.status("Commands:")
+
+      @commands.each do |value|
+        UI.status("   %s" % value.to_s())
+      end
+
+      UI.new_line()
+      UI.status("See 'r2do help <command>' for more information on a specific command.")
+    end
+
+    # Show the version number of the application
+    #
+    # @param [Array] args the list of args the user passed the application
+    # @return [void]
+    def show_version(args)
+      UI.status(R2do::VERSION)
+    end
+
+  end
+
+end

data/lib/r2do/version.rb

@@ -0,0 +1,19 @@
+#
+#  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
+  VERSION = '0.0.6'
+end

data/lib/r2do.rb

@@ -0,0 +1,117 @@
+#
+#  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 'yaml'
+
+require 'r2do/ui'
+require 'r2do/category'
+require 'r2do/task'
+require 'r2do/exceptions'
+require 'r2do/command'
+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/handlers/handle_current'
+require 'r2do/utility'
+
+
+module R2do
+  class App
+    include R2do
+    include Utility
+    include Handlers
+
+    # 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"
+
+      @state = load_state(@file_name)
+    end
+
+    # Evaluates the command passed by the user and calls the corresponding application command.
+    #
+    # @return [void]
+    def run()
+      option = @args[0]
+
+      if @args.length > 0
+        cmd = find_command(option)
+        if not cmd.nil?
+          cmd.execute(@args)
+        else
+          invalid_command(option)
+        end
+      else
+        show_help(@args)
+      end
+    end
+
+    # Saves the state of the application
+    #
+    # @return [void]
+    def save()
+      if @modified
+        save_state(@file_name, @state)
+      end
+    end
+
+    private
+
+    # Creates the list of commands the application responds to.
+    #
+    # @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
+    end
+
+    # Finds the command based on the option value passed by the user
+    #
+    # @param [String] option the option the user passed the application
+    # @return [Command] the command identified by option, else nil
+    def find_command(option)
+      @commands.find { |cmd| cmd.short == option or cmd.extended == option }
+    end
+
+    # Invalid command handler
+    #
+    # @param [String] option the option the user passed the application
+    # @return [void]
+    def invalid_command(option)
+      UI.status("r2do: '#{option}' is not an r2do command. See 'r2do -h'.")
+    end
+
+  end
+
+end

data/r2do.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-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.homepage      = ""
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "redcarpet"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "r2do"
+  gem.require_paths = ["lib"]
+  gem.version       = R2do::VERSION
+end