skipdir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cefd6a2020988b3e49a7d1b4f616b4a6806fbac7
+  data.tar.gz: e7b36f3e3153e16fcda3aca019fea45a02759cc2
+SHA512:
+  metadata.gz: 69543260fe11aded34d27c83d85b945c4ef32150f550300aa61892c46e06f4035b7c17a0dfad667e8d7453eb1f9e76c10f8a0ba4c5f489181ffa8645a49a5c92
+  data.tar.gz: c709e5b5f21ba6f2e7af23337d9142c70e9e8e5fb8d0086bdab7f766d2208b73824f7a24229a655c800482fb886dcb0031a9b3cf293aaa97b352c0a6f78b3e77

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end
+
+gem 'thor', "~>0.19"

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.7)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.0)
+    highline (1.7.1)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.3.0)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+  thor (~> 0.19)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 fhur
+
+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.rdoc

@@ -0,0 +1,19 @@
+= skipdir
+
+Simple utility to manage bookmarked directories.
+
+== Contributing to skipdir
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2015 fhur. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "skipdir"
+  gem.homepage = "http://github.com/fhur/skipdir"
+  gem.license = "MIT"
+  gem.summary = %Q{Command line utility to manage bookmarked directories}
+  gem.description = gem.summary
+  gem.email = "fernandohur@gmail.com"
+  gem.authors = ["fhur"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "skipdir #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/sd

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby
+
+require 'thor'
+require 'skipdir.rb'
+
+class SkipDirCli < Thor
+
+  LOCATION = "#{Dir.home}/.skipdir"
+
+  desc 'add ${alias}', 'Adds the current directory to the bookmark with the given alias'
+  def add(name, dir=Dir.pwd)
+    if name.strip.split(' ').size > 1
+      STDERR.puts 'Spaces not allowed for aliases'
+    end
+    puts "Adding alias '#{name}' => '#{dir}'"
+
+    @skipdir = SkipDir.new(LOCATION)
+    @skipdir.add name, dir
+  end
+
+  desc 'go ${alias}', "cd's to the given alias' directory"
+  def go(name)
+    @skipdir = SkipDir.new(LOCATION)
+    dir = @skipdir.get name
+    if dir.nil?
+      STDERR.puts "Alias #{name} not found"
+    else
+      Dir.chdir(dir)
+    end
+  end
+
+  desc 'list', "Shows a list of all saved bookmarks with their alias"
+  def list()
+    @skipdir = SkipDir.new(LOCATION)
+    max_key_len = @skipdir.all.map { |entry| entry[0].size }.max
+    @skipdir.all.each do |key, value|
+      puts key + ([" "] * (max_key_len + 1 - key.size)).join + value
+    end
+  end
+
+  desc 'rm ${alias}', "Removes the given alias"
+  def remove(name)
+    @skipdir = SkipDir.new(LOCATION)
+    unless @skipdir.remove(name)
+      STDERR.puts "No alias was found"
+    end
+  end
+
+  default_task :go
+
+end
+SkipDirCli.start ARGV

data/lib/skipdir.rb

@@ -0,0 +1,84 @@
+require 'set'
+
+class SkipDir
+
+  def initialize(location)
+    @location = location
+    unless File.exist? @location
+      File.open(@location, 'w') do end
+    end
+
+    @entries = read_map
+  end
+
+  # Adds a mapping from the given name to the given directory
+  # @return a list of all current mappings as an array
+  def add(name, dir)
+    @entries[name.to_s] = dir.to_s
+    save_map
+    return @entries
+  end
+
+  # The current mapping for the given alias or nil if there is no mapping
+  def get(name)
+    entry = @entries[name]
+    if entry
+      return entry
+    else
+      @entries.each do |name_alias, dir|
+        return dir if name_alias.start_with? name
+      end
+    end
+    return nil
+  end
+
+  # A list of all current mappings
+  def all
+    @entries
+  end
+
+
+  # removes the entry with the given name.
+  # @return the removed dir or nil if no entry was found with that name
+  def remove(name)
+    if @entries.include? name
+      dir = @entries[name]
+      @entries.delete name
+      save_map
+      return dir
+    else
+      return nil
+    end
+  end
+
+  private
+
+  # Reads from the file at @location (which is expected to exist)
+  # and creates a map. This file should be composed of lines where each
+  # line is a "name value" pair. There can only be one " " character per line
+  # which is the separation character.
+  def read_map
+    file = File.read(@location)
+
+    lines = file.split("\n")
+    entries = {}
+    lines.each do |line|
+      entry = line.gsub("alias 'sd-",'')
+        .gsub("'cd ",'')
+        .gsub("'",'')
+        .split("=")
+      entries[entry[0]] = entry[1]
+    end
+
+    return entries
+  end
+
+  # Saves the current @entries map to the file at @location
+  def save_map
+    File.open(@location, 'w') do |file|
+      @entries.each do |key, value|
+        file.write "alias 'sd-#{key}'='cd #{value}'\n"
+      end
+    end
+  end
+end

data/test/skipdir_spec.rb

@@ -0,0 +1,58 @@
+require 'minitest/autorun'
+require 'skipdir.rb'
+
+describe SkipDir do
+
+  before :each do
+    @location = "./pkg/tmp-#{(rand*(10**15)).to_i}.skipdir"
+    @skipdir = SkipDir.new @location
+  end
+
+  after :each do
+    `rm #{@location}`
+  end
+
+  describe 'add' do
+    it 'should add a new entry to skipdir' do
+      @skipdir.add 'foo','./tmp/bar/foo/'
+      @skipdir.get('foo').wont_be_nil
+    end
+
+    it 'should return a map of all existing entries' do
+      entries = {
+        'foo': './tmp/dir1',
+        'bar': './tmp/dir2',
+        'baz': './tmp/dir3'
+      }
+      entries.each do |key, val|
+        @skipdir.add key, val
+      end
+
+      stored_entries = @skipdir.add 'new','./dir/to/file'
+      stored_entries.size.must_equal 4
+      stored_entries['new'].must_equal './dir/to/file'
+    end
+  end
+
+  describe 'get' do
+    it 'should return nil for non existing entires' do
+      entry = @skipdir.get('some-non-existing-entry')
+      entry.must_equal nil
+    end
+
+    it 'should return the dir of an entry if it matches' do
+      entries = {
+        'foo': './tmp/dir1',
+        'bar': './tmp/dir2',
+        'baz': './tmp/dir3'
+      }
+      entries.each do |key, val|
+        @skipdir.add key, val
+      end
+
+      @skipdir.get('foo').must_equal './tmp/dir1'
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: skipdir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fhur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Command line utility to manage bookmarked directories
+email: fernandohur@gmail.com
+executables:
+- sd
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/sd
+- lib/skipdir.rb
+- test/skipdir_spec.rb
+homepage: http://github.com/fhur/skipdir
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Command line utility to manage bookmarked directories
+test_files: []