medoc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cc495dc9325fa5da31205f20af23ce1211f4d96
+  data.tar.gz: c12e22d15989aa43d7786f435252707208a40397
+SHA512:
+  metadata.gz: 43b166af257fa00c4fbf9b95ab8ccdc58ea9d07a92cee0f084e91ea4d0effc08a2144ff7abdce7daa50d7094bcd73dc0cb9bb0a52c309c74fa438521cf753bdf
+  data.tar.gz: db0ba4b73e5b196991ed2c9b1a08da0183eed377b16bad54f085012932c12c6b6de99bccf76a07e63f6dbcf0a798d0d611de75ffbb0fb39be6569fc60924aa89

data/README.md

@@ -0,0 +1,48 @@
+# Medoc
+
+Medoc is a tiny Ruby gem for managing you shell aliases. Jump to another directory in a clever way.
+
+## Get started
+
+To install Medoc, run this command:
+
+```
+gem install medoc
+```
+
+Once done, open your `.bash_profile` file, or another `profile` you are using with your shell. Then, append this code:
+
+```bash
+# Medoc config
+medoc_exec() {
+    cd "`/usr/bin/medoc $@`"
+}
+
+alias medoc=medoc_exec
+```
+
+Here you go! Run `medoc your-alias` to leap to a directory.
+
+## Configuration file
+
+Medoc lets user using a configuration file to define all his/her aliases: `~/.medoc.yml`.
+
+When you are using Medoc for the first time, run `medoc --init` to automatically generate this file.
+
+Config file is a simple YAML file. Here is a sample:
+
+```yaml
+my-first-alias: path/to/my/fabulous/directory
+
+another-alias: path/to/another/directory
+
+magic-alias:
+	- my-first-alias
+	- path/to/random/directory # Relative to previous one
+	- another-alias
+	- path/to/somewhere
+```
+
+As you may have seen, you can define an alias using two ways. First one is the simplest: just specify the path to your directory.
+
+Other way is an array mixing aliases and directories. Use here existing aliases and normal directories. Medoc will get the job done for you.

data/bin/medoc

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+require 'medoc'
+#require 'pry'
+
+def no_cd
+  $stdout.puts ''
+end
+
+def version
+  $stderr.puts "Medoc #{Medoc.version} - Adrien Cadet"
+  no_cd
+end
+
+def help
+  $stderr.puts "
+Medoc lets you define shortcuts to jump quickly to another directory.
+
+Usage:
+  medoc \"<alias>\"
+Where
+  alias: alias to run.
+
+Options:
+  --init      Initializes Medoc config file
+  --help      Displays this message
+  --version   Gets current version
+  "
+  no_cd
+end
+
+if ARGV.size < 1
+  help
+else
+  arg = ARGV[0]
+
+  if arg == '--version'
+    version
+  elsif arg == '--help'
+    help
+  elsif arg == '--init'
+    begin
+      Medoc.init
+      $stderr.puts "Created #{Medoc.config_file}"
+      no_cd
+    rescue MedocError => e
+      $stderr.puts e.embedded_message
+      no_cd
+    rescue => e
+      $stderr.puts e.message
+      no_cd
+    end
+  else
+    begin
+      $stdout.puts File.expand_path(Medoc.run arg)
+    rescue MedocError => e
+      $stderr.puts e.embedded_message
+      no_cd
+    rescue => e
+      $stderr.puts e.message
+      no_cd
+    end
+  end
+end

data/lib/medoc.rb

@@ -0,0 +1,135 @@
+require 'yaml'
+#require 'pry'
+
+class MedocError < Exception
+
+  def initialize(message = 'Unknown MedocError')
+    super message
+    @embedded_message = message
+  end
+
+  def embedded_message
+    @embedded_message
+  end
+
+  def embedded_message=(value)
+    @embedded_message = value
+  end
+end
+
+class Medoc
+
+  ###
+   # Path to config file
+   ##
+  @@config_file = File.expand_path '~/.medoc.yml'
+
+  ###
+   # Loaded config
+   ##
+  @@config = nil
+
+  ###
+   # Returns current version
+   ##
+  def self.version
+    '1.0.0'
+  end
+
+  ###
+   # Returns path to config file
+   ##
+  def self.config_file
+    @@config_file
+  end
+
+  ###
+   # Creates default config file
+   ##
+  def self.init
+    if !File.exists? @@config_file
+      f = File.new @@config_file, "w"
+      f.puts '#############################################'
+      f.puts '###           Medoc config file           ###'
+      f.puts '###                                       ###'
+      f.puts '### Visit https://github.com/acadet/medoc ###'
+      f.puts '###     to know more about this file      ###'
+      f.puts '#############################################'
+    else
+      raise MedocError.new "Error: config file is already existing."
+    end
+  end
+
+  ###
+   # Main method. Returns full path matching provided alias
+   ##
+  def self.run(keyword)
+    if !Medoc.load_config
+      # No existing config file
+      raise MedocError.new 'Error: no config file found. You should run medoc --init.'
+    end
+
+    if !@@config
+      # No alias
+      raise MedocError.new 'Error: no alias defined in config file. Visit https://github.com/acadet/medoc to know how to define aliases.'
+    end
+
+    if @@config.has_key? keyword
+      instructions = @@config[keyword]
+      target = ''
+
+      # Instructions can either be a simple directory
+      # or a list of aliases and directories
+      if instructions.kind_of? Array
+        instructions.each do |e|
+          if @@config.has_key?(e) && e != keyword
+            # Instruction is an existing alias
+            target = append target, Medoc.run(e)
+          else
+            # Simple directory
+            target = append target, e
+          end
+        end
+      else
+        # Only a directory
+        target = instructions
+      end
+
+      return target
+    else
+      raise MedocError.new "Error: no '#{keyword}' alias in config file."
+    end
+  end
+
+  private
+
+    ###
+     # Appends a path to new dir
+     ##
+    def self.append(path, dir)
+      if path.size > 0 && path[path.size - 1] != '/'
+        # Append '/' if missing
+        "#{path}/#{dir}"
+      else
+        "#{path}#{dir}"
+      end
+    end
+
+    ###
+     # Loads Medoc config file
+     ##
+    def self.load_config
+      if !@@config.nil?
+        # File already loaded
+        return true
+      end
+
+      # Test if file exists
+      if !File.exists? @@config_file
+        return false
+      end
+
+      @@config = YAML.load_file @@config_file
+      true
+    end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: medoc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adrien Cadet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-04 00:00:00.000000000 Z
+dependencies: []
+description: Medoc is a shell aliases manager. It lets you define shortcuts to jump
+  quickly to another directory.
+email: acadet@live.fr
+executables:
+- medoc
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/medoc
+- lib/medoc.rb
+homepage: https://github.com/acadet/medoc
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Shell alias manager
+test_files: []