yoke 0.1

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jelle Vandebeeck
+
+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,64 @@
+# Yoke
+
+Alias your current directory for fast directory access.
+
+Create an alias for the current directory with a small 'yoke' command. And when you're somewhere else just type the name of the create alias and you'll be cd'ed to the director.
+
+## Installation
+
+Install the gem:
+
+    $ gem install yoke
+
+## Usage
+
+There are only 5 functions you can use with ths gem. We'll start with the beginning.
+
+### Help
+
+Get an overview of all commands available with a small description.
+
+    yoke help
+
+### Setup
+
+Prepare your current shell (bash or zsh) so that it loads the .yoke file every time you start a new shell.
+
+    yoke setup
+
+### up
+
+Create a new alias for the current directory with the name of the current directory.
+
+    yoke
+    yoke up
+    yoke up the_alias_name
+
+You can pass an extra parameter (the\_alias\_name) so that the alias will be this name instead of the current directory name.
+
+### down
+
+Remove the alias that exists with the name of the current directory.
+
+    yoke down
+    yoke down the_alias_name
+
+You can pass an extra parameter (the\_alias\_name) so that the alias with this name will be removed instead of the current directory name.
+
+### list
+
+Show the list of aliases created with yoke.
+
+    yoke list
+
+## License
+
+Check out the LICENSE.txt file. Really awesome reading material...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/yoke

@@ -0,0 +1,30 @@
+#! /usr/bin/ruby
+
+require "thor"
+require "yoke"
+
+class YokeCommand < Thor
+  default_command :up
+
+  desc "up [NAME]", "Create the alias for the current directory with the current directory name or use the given name as the alias."
+  def up(name=nil)
+    Yoke::Base.add(name)
+  end
+
+  desc "down [NAME]", "Remove the alias for the current directory or remove the alias with the given name."
+  def down(name=nil)
+    Yoke::Base.remove(name)
+  end
+
+  desc "list", "List all the aliases."
+  def list
+    Yoke::Base.list
+  end
+
+  desc "setup", "Setup yoke with ZSH/BASH."
+  def setup
+    Yoke::Base.setup
+  end
+end
+
+YokeCommand.start

data/lib/yoke/alias.rb

@@ -0,0 +1,77 @@
+module Yoke
+  class Alias
+    class << self
+      def list
+        return {} unless Yoke::Base.has_alias_file?
+
+        aliases = {}
+        File.readlines(Yoke::Base.alias_file_path).each do |line|
+          if line.start_with? "alias"
+            alias_extract = line.scan(/^alias\s(\w+)\=\"cd (.+)\"$/).last
+            aliases[alias_extract[0]] = alias_extract[1]
+          end
+        end
+        aliases
+      end
+
+      def add(path, name)
+        Yoke::Base.create_alias_file
+        if list.has_key?(name)
+          false
+        else
+          content = []
+          added = false
+          File.readlines(Yoke::Base.alias_file_path).each do |line|
+            if line.start_with? "alias"
+              alias_extract = line.scan(/^alias\s(\w+)\=\"cd (.+)\"$/).last
+              if alias_extract[1] == path
+                content << alias_string(name, path)
+                added = true
+              else
+                content << line
+              end
+            else
+              content << line
+            end
+          end
+          File.open(Yoke::Base.alias_file_path, "w") do |file|
+            content.each { |line| file.puts line }
+          end
+          unless added
+            File.open(Yoke::Base.alias_file_path, 'a') do |file|
+              file.puts alias_string(name, path)
+            end
+          end
+          true
+        end
+      end
+
+      def remove(path, name)
+        return false unless Yoke::Base.has_alias_file?
+
+        if list.has_key?(name)
+          content = []
+          File.readlines(Yoke::Base.alias_file_path).each do |line|
+            if line.start_with? "alias"
+              alias_extract = line.scan(/^alias\s(\w+)\=\"cd (.+)\"$/).last
+              if alias_extract[0] != name
+                content << line
+              end
+            else
+              content << line
+            end
+          end
+          File.open(Yoke::Base.alias_file_path, "w") do |file|
+            content.each { |line| file.puts line }
+          end
+        else
+          false
+        end
+      end
+
+      def alias_string(name, path)
+        "alias #{name.squish.downcase.tr(" ","_")}=\"cd #{path}\""
+      end
+    end
+  end
+end

data/lib/yoke/base.rb

@@ -0,0 +1,143 @@
+require "yoke/alias"
+require "yoke/zsh"
+require "yoke/bash"
+
+module Yoke
+  class Base
+    FILENAME = ".yoke"
+
+    class << self
+      def setup
+        if %x[echo $SHELL].include?("zsh")
+          Yoke::Zsh.setup
+        else
+          Yoke::Bash.setup
+        end
+      end
+
+      def add(name=nil)
+        puts yoke_text
+
+        path = Dir.pwd
+        name = name || File.basename(path)
+        if Yoke::Alias.add(path, name)
+          puts_text("")
+          puts_text("Added #{name} as alias for #{path}")
+        else
+          puts_text("")
+          puts_text("The alias with #{name} already exists")
+        end
+        source_text
+        puts end_text
+      end
+
+      def remove(name=nil)
+        puts yoke_text
+
+        path = Dir.pwd
+        name = name || File.basename(path)
+        if Yoke::Alias.remove(path, name)
+          puts_text("")
+          puts_text("Removed #{name} as an alias")
+        else
+          puts_text("")
+          puts_text("The alias with #{name} is does not exist")
+        end
+        delete_text(name)
+        puts end_text
+      end
+
+      def list
+        puts yoke_text
+
+        list = Yoke::Alias.list
+        if list.count > 0
+          puts_text("")
+          puts_text("Listing all aliases")
+          puts_text("")
+          longest_word_count = list.keys.group_by(&:size).max.last.last.size
+          list.each do |alias_link, path|
+            printf "### %-#{longest_word_count}s %s %-#{sharp_count - 9 - longest_word_count - path.size}s###\n", alias_link, path, ""
+          end
+        else
+          puts_text("")
+          puts_text("No aliases to list")
+        end
+        puts_text("")
+        puts end_text
+      end
+
+      def directory?(path)
+        File.directory?(path)
+      end
+
+      def alias_file_path
+        File.join(Dir.home, FILENAME)
+      end
+
+      def has_alias_file?
+        File.exists?(alias_file_path)
+      end
+
+      def create_alias_file
+        unless has_alias_file?
+          puts_text("")
+          puts_text("Generated #{FILENAME} file")
+          File.open(alias_file_path, "w") { |f| f.write(empty_file_contents) }
+        end
+      end
+
+      def empty_file_contents
+        <<TEXT
+# File generated by Yoke (http://fousa.be/apps/yoke).
+# 
+# Do not alter this file or yoke will stop working correctly.
+#
+TEXT
+      end
+
+      def yoke_text
+        <<TEXT
+#############################################################################################################
+### YOKE ####################################################################################################
+#############################################################################################################
+TEXT
+      end
+
+      def end_text
+        <<TEXT
+#############################################################################################################
+TEXT
+      end
+
+      def delete_text(alias_name)
+        puts_text("")
+        puts_text("To remove this alias immediately run the following command:")
+        puts_text("")
+        puts_text("unalias #{alias_name}")
+        puts_text("")
+        puts_text("Or just start another shell and the aliases are reloaded for you!")
+        puts_text("")
+      end
+
+      def source_text
+        puts_text("")
+        puts_text("You should reload the 'yoke' aliases defined in your .yoke file.")
+        puts_text("You can do this by executing the following command:")
+        puts_text("")
+        puts_text("source ~/.yoke")
+        puts_text("")
+        puts_text("Or just start another shell and the aliases are reloaded for you!")
+        puts_text("")
+      end
+
+      def sharp_count
+        "#############################################################################################################".size
+      end
+
+      def puts_text(text)
+        printf "### %-#{sharp_count - 8}s ###\n", text
+      end
+    end
+  end
+end

data/lib/yoke/bash.rb

@@ -0,0 +1,17 @@
+module Yoke
+  class Bash
+    class << self
+      def custom_path
+        File.join(Dir.home)
+      end
+
+      def setup
+        unless File.exists?(custom_path)
+          File.open(custom_path, 'a') do |file|
+            file.puts "source ~/#{Yoke::Base::FILENAME}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoke/version.rb

@@ -0,0 +1,3 @@
+module Yoke
+  VERSION = "0.1"
+end

data/lib/yoke/zsh.rb

@@ -0,0 +1,17 @@
+module Yoke
+  class Zsh
+    class << self
+      def custom_path
+        File.join(Dir.home, ".oh-my-zsh/custom/yoke.zsh")
+      end
+
+      def setup
+        unless File.exists?(custom_path)
+          File.open(custom_path, 'a') do |file|
+            file.puts "source ~/#{Yoke::Base::FILENAME}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoke.rb

@@ -0,0 +1,5 @@
+require "yoke/version"
+require "yoke/base"
+
+module Yoke
+end

data/yoke.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yoke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yoke"
+  spec.version       = Yoke::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Jelle Vandebeeck"]
+  spec.email         = ["jelle@fousa.be"]
+  spec.description   = %q{Alias your current directory for fast directory access.}
+  spec.summary       = %q{Create an alias for the current directory with a small 'yoke' command. And when you're somewhere else just type the name of the create alias and you'll be cd'ed to the director.}
+  spec.homepage      = "https://github.com/fousa/yoke"
+  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"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency 'thor', '0.18.1'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: yoke
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jelle Vandebeeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: Alias your current directory for fast directory access.
+email:
+- jelle@fousa.be
+executables:
+- yoke
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/yoke
+- lib/yoke.rb
+- lib/yoke/alias.rb
+- lib/yoke/base.rb
+- lib/yoke/bash.rb
+- lib/yoke/version.rb
+- lib/yoke/zsh.rb
+- yoke.gemspec
+homepage: https://github.com/fousa/yoke
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Create an alias for the current directory with a small 'yoke' command. And
+  when you're somewhere else just type the name of the create alias and you'll be
+  cd'ed to the director.
+test_files: []