spath 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5594e6a86f11550e680bd16f75370edde09eb132
+  data.tar.gz: ac0b0c48d7e5ee6ab93a49c1e5ba13306519c151
+SHA512:
+  metadata.gz: 34b27d6977ff187dfec0dd4ad1e8dd59f18ebb51b6b8f512e6634dc5830943a0577724330c801f807c7d18fae3e5cc46665e98cb9ae3292727a39d5a57fee5b3
+  data.tar.gz: 4b0c0984f7b621cf7fa90a88f899361a6a27d0e0e47eac39af8718e4f705a7d9f3574fed12759291cdbae7e2799ee0416d2af360adecbdcd5e0a2d702d977d83

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/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Willis
+
+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,48 @@
+# SPath
+
+'short path'
+
+Use shortcuts when 'cd'ing on the command line.
+(this probably already exists)
+
+Written in Ruby.
+
+## Installation
+
+Install it as:
+
+    $ gem install spath
+
+Add this to your .bashrc:
+
+    function c(){cd $(spath c $*||echo .)}
+
+( This is required because a Ruby script can not change the working directory of its parent process. )
+
+## To do:
+
+Add configuration options.
+
+## Usage
+
+Create shortcuts for common places with the command 's [nick] [path]'
+
+    you@computer ~ $ s foo ~/files/something/lol/whatever/ok
+
+    you@computer ~ $ cd /net/user/you/some/thing/releases/v01-02-03/doc/
+    you@computer ~ $ s ok .
+
+then visit them with the shortcut you made with the command 'c [nick]'.
+
+    you@computer ~ $ c foo
+    you@computer ~/files/something/lol/whatever/ok $
+
+List all available shortcuts with the command 'l'.
+
+    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
+
+Shortcuts are stored at ~/.spath in YAML format.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default do
+  puts "nothing to do"
+end

data/bin/c

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

data/bin/l

@@ -0,0 +1,16 @@
+#!/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

@@ -0,0 +1,18 @@
+#!/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!

data/bin/spath

@@ -0,0 +1,29 @@
+#!/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]`."
+end
+
+usage unless (mode = ARGV[0])
+
+case mode
+when "c"
+
+  usage unless (nickname = ARGV[1])
+
+  config_file = SPath::ConfigFile.load
+  begin
+    puts config_file.path_for(nickname)
+  rescue ArgumentError => msg
+    abort "spath: error: #{msg}"
+  end
+
+else
+  usage
+end

data/lib/spath/version.rb

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

data/lib/spath.rb

@@ -0,0 +1,84 @@
+require "yaml"
+require "spath/version"
+
+module SPath
+  DEFAULT_CONFIG_PATH = File.expand_path("~/.spath")
+
+  class ConfigFile
+
+    attr_accessor :path, :shortcuts, :options 
+
+    def initialize(path = DEFAULT_CONFIG_PATH, shortcuts = [], options = {})
+      @path = File.expand_path(path)
+      @shortcuts = shortcuts
+      @options = options
+    end
+
+    def <<(shortcut)
+      raise ArgumentError "#{shortcut} is not a SPath::Shortcut" \
+        unless shortcut.is_a? Shortcut
+
+      # Make room for new shortcuts
+      @shortcuts.delete_if { |old_shortcut| shortcut.nickname == old_shortcut.nickname }
+
+      # Append to the array
+      @shortcuts << shortcut
+    end
+    alias_method :add_shortcut, :<<
+
+    def to_hash
+      { shortcuts: @shortcuts.map(&:to_hash), options: @options }
+    end
+
+    def write!
+      File.open(@path, "w") { |f| f.write(to_hash.to_yaml) }
+    end
+
+    def self.load(path = DEFAULT_CONFIG_PATH)
+      data = YAML.load(File.read(path))
+
+      # If config file returns empty, use the default
+      return new unless data
+
+      shortcuts = data[:shortcuts].map { |sdata| Shortcut[sdata] }
+      new(path, shortcuts, data[:options])
+    end
+
+    def path_for(nickname)
+      raise ArgumentError, "path does not exist for shortcut #{nickname}" unless \
+        (shortcut = @shortcuts.select { |s| s.nickname.to_s == nickname }.first)
+
+      shortcut.path
+    end
+
+  end
+
+  class Shortcut
+
+     attr_accessor :nickname, :path
+
+     def initialize(nickname, path)
+       raise ArgumentError, "#{nickname} is not alphanumeric" \
+         if nickname.to_s =~ /[^a-z0-9_]/i
+       raise ArgumentError, "nickname is not a string" \
+         unless nickname.respond_to? :to_s
+
+       path = File.expand_path(path)
+       raise ArgumentError, "path '#{path}' doesn't exist" \
+         unless File.exists? path
+
+       @nickname = nickname.to_s.to_sym
+       @path = path
+     end
+
+     def to_hash
+       { nickname: @nickname.to_s, path: @path }
+     end
+
+     # Create instance from hash
+     def self.[](data)
+       new(data[:nickname], data[:path])
+     end
+
+  end
+end

data/spath.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spath/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spath"
+  spec.version       = SPath::VERSION
+  spec.authors       = ["Jack Willis"]
+  spec.email         = ["jack@attac.us"]
+  spec.description   = "spath creates shortcuts for paths"
+  spec.summary       = "shortcuts for paths"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: spath
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Willis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: spath creates shortcuts for paths
+email:
+- jack@attac.us
+executables:
+- c
+- l
+- s
+- spath
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- bin/c
+- bin/l
+- bin/s
+- bin/spath
+- lib/spath.rb
+- lib/spath/version.rb
+- spath.gemspec
+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.3
+signing_key: 
+specification_version: 4
+summary: shortcuts for paths
+test_files: []