r2do 0.0.6

data/spec/r2do/category_spec.rb

@@ -0,0 +1,211 @@
+#
+#  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
+
+  describe Category do
+
+    before :each do
+      @category = Category.new("A category")
+    end
+
+    describe "#new" do
+      context "with a name" do
+        it "returns a Category object" do
+          @category.should be_an_instance_of Category
+        end
+
+        it "contains no tasks" do
+          @category.should have(0).tasks
+        end
+
+        it "contains the correct name" do
+          @category.name.should eql "A category"
+        end
+      end
+
+      context "without a name" do
+        it "raises an error" do
+          expect{ Category.new }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe "#add" do
+      context "a nil task" do
+        it "raises and error" do
+          expect{ @category.add(nil) }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "in empty category" do
+        it "has one task" do
+          task = Task.new("task")
+          @category.add(task)
+          @category.should have(1).tasks
+        end
+      end
+
+      context "in a category with one task" do
+        it "has two tasks" do
+          @category.add(Task.new("task 1"))
+          @category.should have(1).tasks
+
+          @category.add(Task.new("task 2"))
+          @category.should have(2).tasks
+        end
+      end
+
+      context "add duplicate task" do
+        it "raises an exception" do
+          description = "Sample task"
+
+          @category.add(Task.new(description))
+          expect{ @category.add(Task.new(description)) }.to raise_error(TaskAlreadyExistsError)
+        end
+      end
+    end
+
+    describe "#remove" do
+      context "in empty category" do
+        it "raises an error" do
+          expect{ @category.remove(Task.new("Sample Task")) }.to raise_error(TaskNotFoundError)
+        end
+      end
+
+      context "on a category that doesn't contain the task" do
+        it "raises an error" do
+          @category.add(Task.new("My Task"))
+          expect{ @category.remove(Task.new("Task to remove")) }.to raise_error(TaskNotFoundError)
+        end
+      end
+
+      context "on the correct category" do
+        it "returns the task" do
+          task = Task.new("My Task")
+          @category.add(task)
+          removed_task = @category.remove(task)
+          removed_task.should eql task
+        end
+
+        it "has a task less" do
+          task = Task.new("My Task")
+          @category.add(task)
+          @category.should have(1).tasks
+
+          removed_task = @category.remove(task)
+          @category.should have(0).tasks
+        end
+      end
+    end
+
+    describe "#to_s" do
+      context "with one task" do
+        it "returns a description of the task" do
+          result = StringIO.new
+
+          result << "#{@category.name}:\n\n"
+          result << "    %-30s     %s\n" % ["Task", "Completed"]
+          result << "    " << "-"*51
+          result << "\n"
+          result << "    [ ] %-30s \n" % ["Sample task"]
+
+
+          @category.add(Task.new("Sample task"))
+          @category.to_s.should eql result.string
+        end
+      end
+
+      context "with two tasks" do
+        it "returns the correct description of the tasks" do
+          result = StringIO.new
+
+          result << "#{@category.name}:\n\n"
+          result << "    %-30s     %s\n" % ["Task", "Completed"]
+          result << "    " << "-"*51
+          result << "\n"
+          result << "    [ ] %-30s \n" % "First task"
+          result << "    [ ] %-30s \n" % "Second task"
+
+          @category.add(Task.new("First task"))
+          @category.add(Task.new("Second task"))
+          @category.to_s.should eql result.string
+        end
+      end
+    end
+
+    describe "#find_by_description" do
+      context "with no tasks" do
+        it "returns nil" do
+          task = @category.find_by_description('Sample Task')
+          task.should eql nil
+        end
+      end
+
+      context "with tasks" do
+        it "returns nil if you provide the wrong desctiption" do
+          @category.add(Task.new("Sample task"))
+          task = @category.find_by_description("A non existent task")
+          task.should eql nil
+        end
+
+        it "returns the task if it exists" do
+          description = "Sample task"
+          a_task = Task.new(description)
+          @category.add(a_task)
+          return_task = @category.find_by_description(description)
+          return_task.should eql a_task
+        end
+
+        it "returns the task if it exists and there are multiple tasks" do
+          description1 = "Sample task1"
+          description2 = "Sample task2"
+
+          task1 = Task.new(description1)
+          task2 = Task.new(description2)
+
+          @category.add(task1)
+          @category.add(task2)
+
+          return_task = @category.find_by_description(description2)
+          return_task.should eql task2
+        end
+      end
+    end
+
+    describe "#set_current" do
+      it "returns the correct task" do
+        task = Task.new("Sample Task")
+        @category.set_current(task)
+        @category.current_task.should eql task
+      end
+    end
+
+    describe "#clear_current_task" do
+      it "should return nil" do
+        task = Task.new("Sample Task")
+        @category.set_current(task)
+        @category.current_task.should eql task
+
+        @category.clear_current_task()
+        @category.current_task.should eql nil
+      end
+    end
+  end
+
+end

data/spec/r2do/command_spec.rb

@@ -0,0 +1,85 @@
+#
+#  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
+
+  describe Command 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 Command" do
+          command = Command.new('c', 'category', nil, 'description for this command', method(:callback))
+          command.should be_an_instance_of Command
+        end
+      end
+
+      context "null args" do
+        it "raises an error if the swtich is null" do
+          expect{ Command.new(nil, 'category', nil, 'description for this command', method(:callback)) }.to raise_error(ArgumentError)
+        end
+
+        it "raises an error if the name is null" do
+          expect{ Command.new('c', nil, nil, 'description for this command', method(:callback)) }.to raise_error(ArgumentError)
+        end
+
+        it "raises an error if the description is null" do
+          expect{ Command.new('c', 'category', nil, nil, method(:callback)) }.to raise_error(ArgumentError)
+        end
+
+        it "raises an error if the callback is null" do
+          expect{ Command.new('c', 'category', nil, '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 = Command.new(short, extended, nil, 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 = Command.new(short, extended, nil, description, method(:callback))
+        command.execute(args)
+
+        @callback_invoked.should eql true
+      end
+    end
+  end
+
+end

data/spec/r2do/controller_spec.rb

@@ -0,0 +1,54 @@
+#
+#  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
+
+  describe State do
+
+    before :each do
+      @state = State.new()    
+    end
+
+    describe "#new" do
+      context "default constructor" do
+        it "returns a State object" do
+          @state.should be_an_instance_of State
+        end
+
+        it "contains no Categories" do
+          @state.should have(0).categories
+        end
+
+        it "has no selected category" do
+          @state.current_category.should eql nil
+        end
+      end
+    end
+
+    describe "#add" do
+      context "adding one category" do
+        it "contains one category" do
+          @state.add(Category.new("A sample category"))
+          @state.should have(1).categories
+        end
+      end
+    end
+
+  end
+
+end

data/spec/r2do/r2do_spec.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.
+#
+
+# require 'spec_helper'
+
+# module R2do
+
+
+# end

data/spec/r2do/task_spec.rb

@@ -0,0 +1,102 @@
+#
+#  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
+
+  describe Task do
+
+    before :each do
+      @task = Task.new("Task to complete")
+    end
+
+    describe "#new" do
+      context "with a description" do
+        it "returns a Task object" do
+          @task.should be_an_instance_of Task
+        end
+      end
+
+      context "without a description" do
+        it "raises an error" do
+          expect { Task.new }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe "#description" do
+      it "returns the correct description" do
+        @task.description.should eql "Task to complete"
+      end
+    end
+
+    describe "#to_s" do
+      context "on a task that is not completed" do
+        it "returns the correct to string representation" do
+          result = "[ ] %-30s " % ["Task to complete"]
+          @task.to_s.should eql result
+        end
+      end
+
+      context "on a task that is complete" do
+        it "returns the correct to string representation" do
+          date = DateTime.now.strftime('%a %b %e, %Y')
+          result = "[x] %-30s %s" % ["Task to complete", date]
+          @task.completed()
+          @task.to_s.should eql result
+        end
+      end
+    end
+
+    describe "#done" do
+      context "by default" do
+        it "returns false" do
+          @task.done?.should eql false
+        end
+      end
+
+      context "when a task is completed" do
+        it "returns true" do
+          @task.completed()
+          @task.done?.should eql true
+        end
+      end
+    end
+
+    describe "#date_done" do
+      context "when a task is not completed" do
+        it "returns nil" do
+          @task.date_done().should eql nil
+        end
+      end
+
+      context "when a task is completed" do
+        it "returns the correct date" do
+          @task.completed()
+          @task.date_done().strftime("%F").should eql DateTime.now().strftime("%F")
+        end
+
+        # it "cannot be modified" do
+        #   @task.completed()
+        #   expect { @task.date_done = DateTime.now }.to raise_error(NoMethodError)
+        # end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+#
+#  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 'simplecov'
+SimpleCov.start
+
+require 'r2do'

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: r2do
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- cgiacomi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple todo gem
+email:
+- christiangiacomi@gmail.com
+executables:
+- r2do
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/r2do
+- lib/r2do.rb
+- lib/r2do/category.rb
+- lib/r2do/command.rb
+- lib/r2do/exceptions.rb
+- lib/r2do/handlers/handle_categories.rb
+- lib/r2do/handlers/handle_category.rb
+- lib/r2do/handlers/handle_current.rb
+- lib/r2do/handlers/handle_init.rb
+- lib/r2do/handlers/handle_task.rb
+- lib/r2do/state.rb
+- lib/r2do/task.rb
+- lib/r2do/ui.rb
+- lib/r2do/utility.rb
+- lib/r2do/version.rb
+- r2do.gemspec
+- spec/r2do/category_spec.rb
+- spec/r2do/command_spec.rb
+- spec/r2do/controller_spec.rb
+- spec/r2do/r2do_spec.rb
+- spec/r2do/task_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3996115367842685634
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3996115367842685634
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple todo gem
+test_files:
+- spec/r2do/category_spec.rb
+- spec/r2do/command_spec.rb
+- spec/r2do/controller_spec.rb
+- spec/r2do/r2do_spec.rb
+- spec/r2do/task_spec.rb
+- spec/spec_helper.rb
+has_rdoc: