go2dir 0.0.2 → 0.0.3

data/README.md

@@ -1,29 +1,48 @@
 # Go2dir
 
-TODO: Write a gem description
+Are you trying to become a bash ninja? Then, stop typing over and over again the same paths to the same directories! 
+go2dir lets you create shortcuts for your most used paths and change lightning fast your current directory. 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+*Important:* when calling this gem from your cli, it executes in a different process, so running it alone won't take any effect on your current location. For this to work, you need to let your bash evaluate the output commands. I wrote the code myself and use it everyday, but I advise you to check out the code first and make sure you're comfortable with this. 
 
-    gem 'go2dir'
+After that, you can install it by running:
 
-And then execute:
+    $ gem install go2dir
 
-    $ bundle
+next you *must* add this function to your .bashrc:
 
-Or install it yourself as:
+	function gt() { eval $(go2dir $1 $2); }
 
-    $ gem install go2dir
+and reload your bash. 
+Note: you can change <gt> for whatever command you want to use.
 
 ## Usage
 
-TODO: Write usage instructions here
+To add or edit a shortcut:
+
+	$ gt <shortcut> <path>
+
+To use shortcut:
+
+	$ gt <shortcut>
+
+## Example
+
+	$ gt projects ~/Projects/
+	Shorctcut saved sucessfully!
+	$ gt projects
+	$ pwd
+	/Users/brunohq/Projects/
+	$ gt hidden-porn /Users/brunohq/really/long/path/to/your/xxx/video/collection/muhahah/
+	Shorctcut saved sucessfully!
+	$ gt hidden-porn
+	$ pwd
+	/Users/brunohq/really/long/path/to/your/xxx/video/collection/muhahah/
 
-## Contributing
+## Suggestions
+This gem built for my personal use only, but if you feel it could be improved or if you have any suggestions, holla at me. 
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+With love, 
+[@brunohq](http://twitter.com/brunohq)

data/go2dir.gemspec

@@ -5,9 +5,9 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Bruno Costa"]
   gem.email         = ["bruno.costa@hardquarters.com"]
   gem.summary       = "go2dir is a shorcut manager to speed up your command line cding"
-  gem.description   = "Are you tired of typing over and over again the same paths to the
-  same directories? go2dir lets you create shortcuts for your most used paths and change
-  lightning fast your current directory."
+  gem.description   = "Are you trying to become a bash ninja? Then, stop typing over 
+  and over again the same paths to the same directories! go2dir lets you create shortcuts 
+  for your most used paths and change lightning fast your current directory."
 
   gem.homepage      = "https://github.com/brunohq/go2dir"
 

data/lib/go2dir.rb

@@ -7,19 +7,31 @@ module Go2dir
 
 	  def execute(*args)
 	  	return help if args.empty?
-	  	return change_dir(args[0]) if args.length == 1
-	  	return add_shortcut(args[0], args[1]) if args.length == 2
+	  	return get_path(args[0]) if args.length == 1
+	  	return set_shortcut(args[0], args[1]) if args.length == 2
 	  end
 
-	  def change_dir(shortcut)
+	  def get_path(shortcut)
 	  	shortcuts = Go2dir::Storage.load
-	  	puts shortcuts[shortcut]
+	  	if shortcuts.has_key?(shortcut)
+	  		puts "cd #{shortcuts[shortcut]}"
+	  	else
+	  		puts "echo 'This shortcut is not defined!'"
+	  	end
 	  end
 
-	  def add_shortcut(shortcut, path)
+	  def set_shortcut(shortcut, path)
 	  	shortcuts = Go2dir::Storage.load
 	  	shortcuts[shortcut] = path
 	    Go2dir::Storage.save(shortcuts)
+	    puts "echo 'Shortcut saved sucessfully!'"
+	  end
+
+	  def help
+      puts "echo 'To add or edit a shortcut:';"
+			puts "echo '\ $ gt <shortcut> <path>';"
+			puts "echo 'To use shortcut:';"
+			puts "echo '\ $ gt <shortcut>';"
 	  end
 
 	end

data/lib/go2dir/version.rb

@@ -1,3 +1,3 @@
 module Go2dir
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: go2dir
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,15 +9,15 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-04-14 00:00:00.000000000 Z
 dependencies: []
-description: ! "Are you tired of typing over and over again the same paths to the\n
-  \ same directories? go2dir lets you create shortcuts for your most used paths and
-  change\n  lightning fast your current directory."
+description: ! "Are you trying to become a bash ninja? Then, stop typing over \n  and
+  over again the same paths to the same directories! go2dir lets you create shortcuts
+  \n  for your most used paths and change lightning fast your current directory."
 email:
 - bruno.costa@hardquarters.com
 executables:
-- go2dir.rb
+- go2dir
 extensions: []
 extra_rdoc_files: []
 files:
@@ -26,7 +26,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/go2dir.rb
+- bin/go2dir
 - go2dir.gemspec
 - lib/go2dir.rb
 - lib/go2dir/storage.rb