rabbit_hole 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 003a74074b3696cbd896f8692f9fbf1fc5e6beb4
+  data.tar.gz: 9ae58825cc0855f06ab8eb22bb13a98578ffcec5
+SHA512:
+  metadata.gz: 3b426b098a0307fae273bf0bb645898f30019c1e03f20994c57e18d1541ab6f3f0f32dde036c32527cdfe497acdda18ef47da7d0b7ff8e83c880f520ad714cd7
+  data.tar.gz: 72f709036c181677a0800b18eeb67826955f6176714a02f9c2ae8b8d0e304f7514fea90b4530a1dd12863483e85f79b8be5dd447c15069da74480f5653a837e5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rabbit_hole.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Underwood
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# RabbitHole
+
+Ever have one of those situations where every task seems to spawn another one, and another one, and another one?
+
+Eventually you forget where you started and end up lost in a mess of documentation, source code, and config files.
+
+A rabbit hole.
+
+Use this gem to find your way back out again. Add each new task as you start it, and RabbitHole will keep track of your task stack for you. When you finish a task, tell RabbitHole and it'll remind you what you were working on before. Keep going til you get back to your starting point.
+
+## Installation
+
+    $ gem install rabbit_hole
+
+## Usage
+
+Add new tasks:
+
+    $ rabbithole add "My new task"
+
+See the current task:
+
+    $ rabbithole current
+
+Complete the current task:
+
+    $ rabbithole complete
+
+Remind yourself how deep you are:
+
+    $ rabbithole show
+
+### Abbreviations
+
+All commands can be abbreviated as long as they're unambiguous.
+
+e.g. `rabbithole s` maps to `rabbithole show`.
+
+### Aliases
+
+I recommend adding an alias to your shell as typing 'rabbithole' all the time is cumbersome.
+
+I use `alias rh="rabbithole"`.
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Write code and tests
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request

data/bin/rabbithole

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'rabbit_hole'
+
+RabbitHole::CLI.start(ARGV)

data/lib/rabbit_hole.rb

@@ -0,0 +1,4 @@
+require "rabbit_hole/version"
+require "rabbit_hole/base"
+require "rabbit_hole/cli"
+

data/lib/rabbit_hole/base.rb

@@ -0,0 +1,58 @@
+require "yaml"
+
+module RabbitHole
+
+  class Base
+
+    def initialize(yml_path = "#{Dir.home}/.rabbit_hole.yml")
+      @yml_path = yml_path
+    end
+
+    def push(task)
+      with_stack do |stack|
+        stack.push(task)
+      end
+    end
+
+    def pop
+      with_stack do |stack|
+        stack.pop
+      end
+    end
+
+    def top
+      with_stack do |stack|
+        stack.last
+      end
+    end
+
+    def size
+      with_stack do |stack|
+        stack.size
+      end
+    end
+
+    def tasks
+      with_stack do |stack|
+        stack
+      end
+    end
+
+    private
+
+    def with_stack
+
+      if File.file?(@yml_path)
+        stack = YAML.load_file(@yml_path)
+      else
+        stack ||= []
+      end
+
+      result = yield stack
+
+      File.open(@yml_path, 'w') { |f| YAML.dump(stack, f) }
+
+      result
+    end
+  end
+end

data/lib/rabbit_hole/cli.rb

@@ -0,0 +1,36 @@
+require "thor"
+
+module RabbitHole
+  class CLI < Thor
+    desc "add TASK", "Adds TASK to the top of the stack"
+    def add(task)
+      stack = Base.new
+      stack.push task
+      puts "Added task '#{task}' to the stack!"
+    end
+
+    desc "current", "show the current task"
+    def current
+      stack = Base.new
+      puts "Currently working on: '#{stack.top}'"
+    end
+
+    desc "complete", "Complete the current task"
+    def complete
+      stack = Base.new
+      puts "Completed: '#{stack.pop}'"
+      puts "Next task: '#{stack.top}'"
+    end
+
+    desc "show", "Show all tasks in the stack"
+    def show
+      stack = Base.new
+      tasks = stack.tasks
+      puts "#{tasks.size} levels deep"
+      puts "Current task: #{tasks.last}"
+      tasks[0...-1].each do |task|
+        puts task
+      end
+    end
+  end
+end

data/lib/rabbit_hole/version.rb

@@ -0,0 +1,3 @@
+module RabbitHole
+  VERSION = "0.0.1"
+end

data/rabbit_hole.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rabbit_hole/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rabbit_hole"
+  spec.version       = RabbitHole::VERSION
+  spec.authors       = ["David Underwood"]
+  spec.email         = ["davefp@gmail.com"]
+  spec.summary       = %q{A quick and dirty command-line task organizer for finding your way out of rabbit-holes}
+  spec.description   = %q{RabbitHole is designed for those times when you realize you're disappearing down a rabbit-hole and want to remember how you got there. Add successive tasks with `taskstack add TASK`. Mark the current task completed with `taskstack complete`, and it'll show you the task you were working on previously.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.18"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/base_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+describe RabbitHole do
+
+  before do
+
+    yml_path = "#{Dir.home}/.rabbit_hole_test.yml"
+
+    File.open(yml_path, "w") {|f| YAML.dump([], f)}
+    @task_stack = RabbitHole::Base.new(yml_path)
+  end
+
+  context "add task" do
+
+    before do
+      @task = "My new task"
+    end
+
+    it "should add the task to the top of the stack" do
+      @task_stack.push(@task)
+      @task_stack.top.should eq @task
+    end
+
+    it "should increase the size of the stack by 1" do
+      old_size = @task_stack.size
+      @task_stack.push(@task)
+
+      @task_stack.size.should eq (old_size + 1)
+    end
+
+  end
+
+  context "remove task" do
+
+    before do
+      @task = "My old task"
+      @task_stack.push(@task)
+    end
+
+    it "should return the last task" do
+      other_task = @task_stack.pop
+
+      other_task.should eq @task
+    end
+
+    it "should remove the top task from the stack" do
+      @task_stack.pop
+
+      @task_stack.top.should_not eq @task
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rabbit_hole' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rabbit_hole
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Underwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: RabbitHole is designed for those times when you realize you're disappearing
+  down a rabbit-hole and want to remember how you got there. Add successive tasks
+  with `taskstack add TASK`. Mark the current task completed with `taskstack complete`,
+  and it'll show you the task you were working on previously.
+email:
+- davefp@gmail.com
+executables:
+- rabbithole
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/rabbithole
+- lib/rabbit_hole.rb
+- lib/rabbit_hole/base.rb
+- lib/rabbit_hole/cli.rb
+- lib/rabbit_hole/version.rb
+- rabbit_hole.gemspec
+- spec/base_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A quick and dirty command-line task organizer for finding your way out of
+  rabbit-holes
+test_files:
+- spec/base_spec.rb
+- spec/spec_helper.rb