spath 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5594e6a86f11550e680bd16f75370edde09eb132
-  data.tar.gz: ac0b0c48d7e5ee6ab93a49c1e5ba13306519c151
+  metadata.gz: e7d49c015ba3a6ae33e809dbb66d615e4d1f8558
+  data.tar.gz: 600c48f74a64fac517fbafe1c74ff3690ac6db84
 SHA512:
-  metadata.gz: 34b27d6977ff187dfec0dd4ad1e8dd59f18ebb51b6b8f512e6634dc5830943a0577724330c801f807c7d18fae3e5cc46665e98cb9ae3292727a39d5a57fee5b3
-  data.tar.gz: 4b0c0984f7b621cf7fa90a88f899361a6a27d0e0e47eac39af8718e4f705a7d9f3574fed12759291cdbae7e2799ee0416d2af360adecbdcd5e0a2d702d977d83
+  metadata.gz: 463814c89a66055c57132f91e6c92744d21f6a9595b1e2794d0dcad3458a7c8db75ebdc634535e5645c90046d15ab1100269ff339751131cc299cd123c08e408
+  data.tar.gz: e93f5f63fe2fd71752cf9e482caff56d23f09a0ee2505a0319f1a4681a109d4b88fdb2ea44e89a1547d9949bf31119387abc1dcdb62007687f1b290e6dd45643

data/README.md

@@ -13,36 +13,42 @@ Install it as:
 
     $ gem install spath
 
-Add this to your .bashrc:
+Add this to your .bashrc (suggested):
 
-    function c(){cd $(spath c $*||echo .)}
+    alias s='spath create'
+    alias l='spath list'    
+    function c(){cd $(spath path $*||echo .)}
 
-( This is required because a Ruby script can not change the working directory of its parent process. )
+( c is required to be defined as a function because a Ruby script can not change the working directory of its parent process. )
 
 ## To do:
 
 Add configuration options.
+Add tests.
+Add better error handling.
 
 ## Usage
 
-Create shortcuts for common places with the command 's [nick] [path]'
+Create shortcuts for common places with the command 'spath create [nick] [path]'
 
-    you@computer ~ $ s foo ~/files/something/lol/whatever/ok
+    $ spath create ltr /home/you/docs/letters
 
-    you@computer ~ $ cd /net/user/you/some/thing/releases/v01-02-03/doc/
-    you@computer ~ $ s ok .
+Non-absolute paths are acceptable.
 
-then visit them with the shortcut you made with the command 'c [nick]'.
+    $ cd /home/you/public/long/path/skynet/releases/v01-02-03/doc/
+    $ spath create snet ../
 
-    you@computer ~ $ c foo
-    you@computer ~/files/something/lol/whatever/ok $
+Visit them with the shortcut you made with the function 'c [nick]'.
 
-List all available shortcuts with the command 'l'.
+    you@computer $ c snet
+    you@computer $ pwd
+    /home/you/public/long/path/skynet/releases/v01-02-03/
 
-    you@computer ~ $ l
-    l: list spath shortcuts.
-      ok => /net/user/you/some/thing/releases/v01-02-03/doc/
-    abin => /usr/share/Adobe/doc/example/android_vm/root/sbin
-     foo => /home/you/files/something/lol/whatever/ok
+List all available shortcuts with the command 'spath list'.
+
+    you@computer ~ $ spath list
+     snetdoc => /home/you/public/long/path/skynet/releases/v01-02-03/
+         ltr => /home/you/docs/letters
+          mu => /home/you
 
 Shortcuts are stored at ~/.spath in YAML format.

data/bin/spath

@@ -1,29 +1,50 @@
 #!/usr/bin/env ruby
-# coding: utf-8
 
-# spath: provide all functions, about message, configuration
-
-$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/../lib")
 require "spath"
 
 def usage
-  abort "spath: create shortcuts. Usage: `spath c [nick]`."
+  abort <<EOF
+spath (v#{SPath::VERSION}): create shortcuts. Usage:
+  spath path [nick]
+  spath list
+  spath create [nick] [path]
+EOF
 end
 
-usage unless (mode = ARGV[0])
+mode, nickname, path = ARGV
+usage unless mode
+
+config_file = SPath::ConfigFile.load
 
 case mode
-when "c"
+when "path"
 
-  usage unless (nickname = ARGV[1])
+  usage unless nickname
 
-  config_file = SPath::ConfigFile.load
   begin
     puts config_file.path_for(nickname)
   rescue ArgumentError => msg
     abort "spath: error: #{msg}"
   end
 
+when "list"
+
+  usage if nickname or path
+
+  shortcuts = config_file.shortcuts
+  shortcuts.each { |s| puts "#{s.nickname.to_s.rjust(8)} => #{s.path}" }
+
+when "create"
+
+  usage unless nickname and path
+
+  path = File.expand_path(path)
+  abort "spath: error: #{path} is not a valid path. :(" \
+    unless File.exists?(path)
+
+  config_file << SPath::Shortcut.new(nickname, path)
+  config_file.write!
+
 else
   usage
 end

data/lib/spath.rb

@@ -35,6 +35,10 @@ module SPath
     end
 
     def self.load(path = DEFAULT_CONFIG_PATH)
+      path = File.expand_path(path)
+
+      return new unless File.exists?(File.expand_path(path))
+
       data = YAML.load(File.read(path))
 
       # If config file returns empty, use the default

data/lib/spath/version.rb

@@ -1,3 +1,3 @@
 module SPath
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spath.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jack@attac.us"]
   spec.description   = "spath creates shortcuts for paths"
   spec.summary       = "shortcuts for paths"
-  spec.homepage      = ""
+  spec.homepage      = "http://github.com/jackwillis/spath"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spath
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jack Willis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,9 +42,6 @@ description: spath creates shortcuts for paths
 email:
 - jack@attac.us
 executables:
-- c
-- l
-- s
 - spath
 extensions: []
 extra_rdoc_files: []
@@ -53,14 +50,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/c
-- bin/l
-- bin/s
 - bin/spath
 - lib/spath.rb
 - lib/spath/version.rb
 - spath.gemspec
-homepage: ''
+homepage: http://github.com/jackwillis/spath
 licenses:
 - MIT
 metadata: {}

data/bin/c

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-# ruby command can not change directory by itself
-echo "attempt cd $(spath c $*)"
-cd $(spath c $*)

data/bin/l

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-# coding: utf-8
-
-# l: list shortcuts
-
-$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/../lib")
-require "spath"
-
-abort unless ARGV.empty?
-
-puts "l: list spath shortcuts."
-
-config_file = SPath::ConfigFile.load
-shortcuts = config_file.shortcuts
-
-shortcuts.each { |s| puts "#{s.nickname.to_s.rjust(8)} => #{s.path}" }

data/bin/s

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-# coding: utf-8
-
-# s: create shortcut
-
-$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/../lib")
-require "spath"
-
-nickname, path = ARGV
-abort "s: create spath shortcut. Usage: s [nickname] [path]" \
-  unless nickname and path
-
-path = File.expand_path(path)
-abort "s: error: #{path} is not a valid path. :(" unless File.exists? path
-
-config_file = SPath::ConfigFile.load
-config_file << SPath::Shortcut.new(nickname, path)
-config_file.write!