diru 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52998510ee6ded3ea6fa81a826e82e648cbffb1abf1174a985ee71627bfc2d75
-  data.tar.gz: ee3d26f1d9d6668e67e9eabe0b34402a5b5c7e477d20a6cb58f1d51da4449ab3
+  metadata.gz: bff41ddbd0a089a76fbac53809a65e8c63c6fd3b8e41840d7fe2319e3452ad8c
+  data.tar.gz: b0ab6420120c5bf94cfa55bf62f7de4433b99997c5e68e7a12391c7154aa9321
 SHA512:
-  metadata.gz: f4dbaef3dc53c31010493374b2feefd8c15f01a2e1cbfac777ccee14e7488208b3f27c195abd2ce4d51d5ebfe34493bba734551d4ef6ff9b2cbe4bae8ac6a9ff
-  data.tar.gz: bb18dc7513830cfbbf4b2b33ef07aa084ccb2b44c4f01ba3b722b81c4d4c60f29b4f82a82d181302acd0847401738542436f08f6eebd62da8e9da87dc49bd3b1
+  metadata.gz: 5748973d952b6bc716ec76f5caa4d9fd6073947f35f65206e037b98b04fcdc7c2125ab4e4fb94ddc9b410fc15dfb0587bd1a7e2535f32203ff32036dc78284ab
+  data.tar.gz: 16ba39420fee22cd668235edfeba88e7629659a30e1510af1f975fc7eea11a847f7c826a5313d98c7d0fdd1c646f01fa3466c0725004557b6c5a58837465b1fb

data/CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = Version history
 
+[0.1.2] Key/value lookup feature.
+        Updates to documentation.
+
 [0.1.1] Prefering string keys for config.
         Prefer json over yaml for options.
         Deprecated DIRU_OPTS_FORMAT env var.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017 tero.isannainen@gmail.com
+Copyright (c) 2017, 2019 tero.isannainen@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,7 @@
 = Diru
 
 * Introduction
+* Quick start guide
 * Getting started
 * Client commands
 * Configuration
@@ -10,7 +11,7 @@
 
 Diru is a Change Directory (cd) utility for augmenting Unix Shell
 functionality. Diru makes it easy and efficient to jump around in
-Project's directories. Diru uses server/client architecture, which
+Project's directories. Diru uses client/server architecture, which
 enables sharing of directory info and state between terminal sessions.
 
 Each Server serves one Project. Project is a tree of related
@@ -19,29 +20,94 @@ root. There can be multiple Servers, if user needs to access multiple
 Projects concurrently.
 
 Client queries directory info from Server and directory change is
-pushed to Shell in order to change the current directory within
+pushed to Shell in order to change the current directory within the
 Shell. Diru is not able to change the Shell directory by itself. User
-must define a Shell function which can actually change the state of
+must define a Shell function which can actually modify the state of
 the Shell.
 
+
 Diru features:
 
 * Support for multiple concurrent Projects.
+
 * User and Project specific options (configuration).
+
 * Jump to Project root.
+
 * Find and jump to dir under Project root (glob and regex search).
+
 * Find and jump to dir under current dir (glob search).
+
 * Fast directory search since Server maintains a memory image of
   directories.
-* Favorite directories in options (configuration), for permanent
-  favorites.
+
+* Configurable favorite directories, for persistent favorites.
+
 * Bookmark saving and referencing, for current favorites.
+
 * Directory change history and history referencing.
+
 * Scratch Pad (with named regs) for directory copy/paste.
+
 * Peer directory jumping, i.e. peer of current (regexp match).
+
+* Key/value store (Lookup) for general purpose information exchange
+  between terminals.
+
 * Online help.
 
 
+
+= Quick start guide
+
+This section defines a minimal number of steps for using Diru. The
+description applies to a single server setup.
+
+== Step 1
+
+Define function (Bourne Shell) for using Diru Client:
+
+    dr()
+    {
+      ret=`diru -p 41115 -c $*`
+      if test $? -eq 0; then
+        cd $ret
+      fi
+    }
+
+== Step 2
+
+Setup project configuration:
+
+    shell> cd my_project
+    shell> diru -t > .diru.json
+
+== Step 3
+
+Start Diru Hub and default Diru Server for "my_project":
+
+    shell> diru --start
+
+== Step 4
+
+Use Client to store current directory to Scratch Pad:
+
+    shell> dr s .
+
+Use Client as usual.
+
+== Step 5
+
+Kill all Servers and the Hub:
+
+    shell> diru --hkill
+
+The Client was ready to use, but ".diru.json" included the default
+template, which should be customized with project related
+values. Modify the configuration before starting Hub and Server again.
+
+
+
 = Getting started
 
 The first thing to do is to start Diru Hub. Hub is a server process
@@ -72,15 +138,15 @@ Hub.
 
 When Server starts, it will detect the Project root. It can be a file
 or defined as environment variable. Environment variable DIRU_ROOT has
-higher precedence than the files. If ".diru_root_dir" file or a
-".diru.[json|yml]" file is found from current dir or some dir above,
-the dir containing either of the files will become the Project
-root. If no files are found and DIRU_ROOT environment variable is not
-used, an error is issued.
+higher precedence than a file based root. If ".diru_root_dir" file or
+a ".diru.json" (or ".diru.yml") file is found from current dir or some
+dir above, the dir containing either of the files will become the
+Project root. If no files are found and DIRU_ROOT environment variable
+is not used, an error is issued.
 
 Client communicates with the Server in order to get and save directory
 info. As mentioned above, Diru is more or less useless unless user has
-defined a Shell function to realize directory changing.
+defined a Shell function to realize the directory changes.
 
 Here is an example of such function for Bourne Shell based shells:
 
@@ -92,11 +158,11 @@ Here is an example of such function for Bourne Shell based shells:
       fi
     }
 
-Diru Client command is called now "dr". We specify with "-p" option,
-that port "42324" is used towards the Server and with "-c" that we
-want to issue directory "change" commands. In practice only part of
-the commands will change directory, since some commands are only for
-queries. Directory is (and should be) changed if Diru returns
+Diru Client command is defined as "dr" now. Option "-p" defines that
+port "42324" is used to identify the Server and option "-c" defines
+that we want to issue directory "change" commands. In practice only
+part of the commands will change directory, since some commands are
+only for queries. Directory is (and should be) changed if Diru returns
 0. Otherwise Diru is performing a non-cd command, and Shell should
 just ignore the current Diru execution.
 
@@ -126,7 +192,7 @@ to previous dir, we do:
 
     shell> dr h 0
 
-Bookmarks have also the same type of number based referencing.
+Bookmarks have the same type of number based referencing.
 
 User can create a command sequence by separating commands with ","
 character. For example if you want to reference Scratch Pad and then
@@ -142,14 +208,17 @@ info from Server.
 
 Search commands:
 
-* "dr r"           - change to Project root dir.
-* "dr r <dir>"     - change to <dir> (somewhere) under Project root dir
-                     (glob).
-* "dr t <dir>"     - change to <dir> (somewhere) under current dir (glob).
-* "dr e <dir>"     - change to <dir> (somewhere) under Project root dir
-                     (regexp).
+dr r:: change to Project root dir.
+
+dr r <dir>:: change to <dir> (somewhere) under Project root dir
+             (glob).
+
+dr t <dir>:: change to <dir> (somewhere) under current dir (glob).
 
-Search can match to multiple directories. First match is used and the
+dr e <dir>:: change to <dir> (somewhere) under Project root dir
+             (regexp).
+
+Search can match multiple directories. First match is used and the
 rest (Left-overs) are displayed to the user. Left-overs are also
 stored, and they can be referenced and used in order of appearance
 with simply issuing "dr" again.
@@ -166,55 +235,68 @@ automatically match to the middle of the string, however regexp does.
 
 Bookmark commands:
 
-* "dr b"           - display bookmarks.
-* "dr b ."         - add current dir to bookmarks.
-* "dr b !"         - reset (clear) bookmarks.
-* "dr b s <file>"  - store bookmarks to <file>.
-* "dr b l <file>"  - load  bookmarks from <file>.
-* "dr b d <num>"   - delete bookmark with <num>.
-* "dr b <num>"     - change dir to bookmark <num>.
+dr b::            display bookmarks.
+dr b .::          add current dir to bookmarks.
+dr b !::          reset (clear) bookmarks.
+dr b s <file>::   store bookmarks to <file>.
+dr b l <file>::   load  bookmarks from <file>.
+dr b d <num>::    delete bookmark with <num>.
+dr b <num>::      change dir to bookmark <num>.
+
 
 History commands:
 
-* "dr h"           - display history.
-* "dr h ."         - add current dir to history.
-* "dr h !"         - reset (clear) history.
-* "dr h 0"         - reference latest history item.
-* "dr h <num>"     - change dir to history <num>.
+dr h::            display history.
+dr h .::          add current dir to history.
+dr h !::          reset (clear) history.
+dr h ,::          reference latest history item.
+dr h <num>::      change dir to history <num>.
+
 
 Scratch Pad commands:
 
-* "dr s ."         - store current dir to Default Scratch Pad.
-* "dr s . <reg>"   - store current dir to <reg> in Scratch Pad.
-* "dr s <dir>"     - store <dir> to Default Scratch Pad.
-* "dr s <d> <r>"   - store <dir> to <reg> in Scratch Pad.
-* "dr s"           - change dir to Default Scratch Pad.
-* "dr s <reg>"     - change dir to <reg> from Scratch Pad.
-* "dr s ="         - display Scratch Pad content.
-* "dr s !"         - reset (clear) Scratch Pad.
+dr s .::          store current dir to Default Scratch Pad.
+dr s . <reg>::    store current dir to <reg> in Scratch Pad.
+dr s <dir>::      store <dir> to Default Scratch Pad.
+dr s <d> <r>::    store <dir> to <reg> in Scratch Pad.
+dr s::            change dir to Default Scratch Pad.
+dr s <reg>::      change dir to <reg> from Scratch Pad.
+dr s =::          display Scratch Pad content.
+dr s !::          reset (clear) Scratch Pad.
+
+
+Lookup commands:
+
+dr l::            list all lookup <key>/<v> pairs.
+dr !::            remove all keys.
+dr ! <key>::      remove <key>.
+dr l <key>::      lookup value for <key>.
+dr l <key> <v>::  store value <v> for <key>.
+
 
 Misc commands:
 
-* "dr p"           - jump to peer dir, i.e. the peer of current (from options).
-* "dr c <cmd>"     - issue RPC command to server (reset etc., see below).
-* "dr f"           - list favorites dirs (from options).
-* "dr f <dir>"     - change dir to favorite <dir>.
-* "dr d m <dir>"   - make directory.
-* "dr d r <dir>"   - remove directory.
-* "dr i"           - show command info.
-* "dr <dir>"       - change to given dir (must be under current).
-* "dr"             - change to next "Left-over" directory.
+dr p::            jump to peer dir, i.e. the peer of current (from options).
+dr c <cmd>::      issue RPC command to server (reset etc., see below).
+dr f::            list favorites dirs (from options).
+dr f <dir>::      change dir to favorite <dir>.
+dr d m <dir>::    make directory.
+dr d r <dir>::    remove directory.
+dr i::            show command info.
+dr <dir>::        change to given dir (must be under current).
+dr::              change to next "Left-over" directory.
+
 
 RPC (Remote Procedure Call) commands:
 
-* "reset" - Reset Server state, i.e. History, Bookmarks, Left-overs.
-* "abook" - Add current dir to Bookmarks.
-* "lbook" - List Bookmarks.
-* "rbook" - Reset Bookmarks.
-* "doc"   - Show command documentation.
-* "dsync" - Synchronize Project dir content data with Server cache.
-* "sync"  - Synchronize Options File content to Server.
-* "lregs" - List Scratch Pad registers.
+reset::  Reset Server state, i.e. History, Bookmarks, Left-overs.
+abook::  Add current dir to Bookmarks.
+lbook::  List Bookmarks.
+rbook::  Reset Bookmarks.
+doc::    Show command documentation.
+dsync::  Synchronize Project dir content data with Server cache.
+sync::   Synchronize Options File content to Server.
+lregs::  List Scratch Pad registers.
 
 
 = Configuration
@@ -222,12 +304,15 @@ RPC (Remote Procedure Call) commands:
 Diru uses several environment variables, which are optional, and
 provides thereby backup values for non-specified command line info.
 
-* DIRU_HUB_PORT    - Hub Port, if nothing, 41114 is used.
-* DIRU_PORT        - Server Port, if nothing, ~/.diru.prt is used
-                     (Port File).
-* DIRU_OPTS        - Options file, if nothing, ~/.diru.[json|yml] is used.
-* DIRU_ROOT        - Project root, used if ".diru_root_dir" and
-                     ".diru.[json|yml]" are missing.
+DIRU_HUB_PORT:: Hub Port, or 41114 if not defined.
+
+DIRU_PORT:: Server Port, or "~/.diru.prt" (Port File) if not
+            defined. See below for details.
+
+DIRU_OPTS:: Options file, or "~/.diru.json" if not defined.
+
+DIRU_ROOT:: Project root, which is used if ".diru_root_dir" and
+            ".diru.json" are missing.
 
 If Hub is started without "--hport" option, Diru checks if
 DIRU_HUB_PORT is defined. If not, port 41114 is used.
@@ -239,14 +324,14 @@ not work if no port info is given.
 If Server is started in a directory where (or above) a file called
 ".diru_root_dir" is found, then Project root is the directory
 containing ".diru_root_dir". If ".diru_root_dir" is not found, but
-".diru.[json|yml]" is found, then Project root is the directory
-containing ".diru.[json|yml]", and Options for Project are taken from
+".diru.json" is found, then Project root is the directory
+containing ".diru.json", and Options for Project are taken from
 that file. Last resort for defining Project root, is DIRU_ROOT
 definition.
 
 If ".diru_root_dir" or DIRU_ROOT is used to define Project root, then
 DIRU_OPTS is used to define Options File. However, if not defined,
-then "~/.diru.[json|yml]" is used for options.
+then "~/.diru.json" is used for options.
 
 The "json" format is searched before "yml" format, and hence "json" is
 selected if both exist.
@@ -258,20 +343,20 @@ An example Options file can be displayed with:
 
 Available options in Options File:
 
-* sync  - Options File and Project directory hierarchy refresh period
-          in seconds (for Server).
+sync:: Options File and Project directory hierarchy refresh period
+       in seconds (for Server).
 
-* dsync - Project directory hierarchy refresh period. This overrides
-          "sync" for Project updates (only). If value is 0, then no
-          updates are done after initial update when Server
-          starts. User might want to use 0, if the directory
-          hierarchy is big and/or does not change (often).
+dsync:: Project directory hierarchy refresh period. This overrides
+        "sync" for Project updates (only). If value is 0, then no
+        updates are done after initial update when Server starts. User
+        might want to use 0, if the directory hierarchy is big and/or
+        does not change (often).
 
-* hist  - number of entries in history (max).
+hist:: number of entries in history (max).
 
-* favs  - tagged favorite dirs.
+favs:: tagged favorite dirs.
 
-* peers - <regexp>,<str> pairs for peer matching (String#sub method).
+peers:: <regexp>,<str> pairs for peer matching (String#sub method).
 
 
 = Practical usage tips
@@ -284,8 +369,9 @@ Project. Depending on the usage pattern, user might as well want to
 use the Port File.
 
 Each Project could benefit from specific Options File, and hence user
-can mark the Project Root with ".diru.[json|yml]" and specify the
-Project setup there.
+can mark the Project Root with ".diru.json" (or ".diru.yml") and
+specify the Project setup there. Default is to define the Project Root
+with a ".diru.json" file.
 
 Server caches all Project directory entries from disk to memory. This
 means that Client can quickly jump to any directory, even deep in the
@@ -294,7 +380,7 @@ otherwise the search results in too many Left-overs, which is
 impractical. Server updates the cache either periodically or only at
 start-up. User might prefer no automatic update, if the hierarchy is
 very large and extra load on disk is to be avoided. Cache update can
-be performed at will with an RPC call, "dsync".
+be performed, anyhow, at will with an RPC call, "dsync".
 
 If user is working with a programming project, it is fairly common to
 have separate sub-directories for source code and build targets. Let's
@@ -316,4 +402,14 @@ Options File can be edited while Server is running. Server reads the
 Options File every 5 seconds (configurable with "sync") and refreshes
 its internal state. Server also updates its internal cache of Project
 directory content at each refresh cycle (by default). If "dsync"
-Option is specified, it defines the "dsync" rate.
+Option is specified, it defines the "dsync" rate specifically.
+
+The "dr" Shell function is in practice compulsory. In addition to "dr"
+function, it is convenient to have a "dri" function. "dri" is meant
+for interactive queries only, and obviously can have any name the user
+wants.
+
+    dri() { diru -p 42324 -c $*  2>&1 }
+
+This function returns Diru stderr responses as stdout and hence it is
+easy to pipe this to other Shell commands.

data/bin/diru

@@ -73,6 +73,7 @@ Spec.command( 'diru', 'Tero Isannainen', '2017',
         [ :opt_single,    'hport',    nil,    "H:   Hub port (default: DIRU_HUB_PORT or 41114)." ],
         [ :switch,        'hkill',    nil,    "H:   Kill hub." ],
         [ :switch,        'nodaemon', nil,    "H:   No daemon for server." ],
+        [ :switch,        'start',    nil,    "HS:  Start hub and default server." ],
         [ :opt_any,       'server',   '-s',   "S:   Open server for user (default: $USER)." ],
         [ :opt_single,    'kill',     '-k',   "S:   Close server." ],
         [ :switch,        'list',     '-l',   "S:   List servers." ],
@@ -103,13 +104,16 @@ module Diru
         @conf = conf_file.load
     end
 
-
     # Error message display.
-    def Diru.error( msg )
+    def Diru.error_msg( msg )
         STDERR.puts "Diru Error: #{msg}"
-        exit( false )
     end
 
+    # Error message display with exit.
+    def Diru.error( msg )
+        Diru.error_msg( msg )
+        exit( false )
+    end
 
     # Warning message display.
     def Diru.warn( msg )
@@ -181,15 +185,6 @@ module Diru
         found
     end
 
-
-    def Diru.opts_filename
-        if ENV['DIRU_OPTS_FORMAT']
-            ".diru.#{ENV['DIRU_OPTS_FORMAT']}"
-        else
-            ".diru.yml"
-        end
-    end
-
 end
 
 
@@ -281,6 +276,9 @@ class Search
         # Favorites.
         @fav = {}
 
+        # Lookup database.
+        @lut = {}
+
         # History limit.
         @histlimit = 20
 
@@ -488,6 +486,34 @@ class Search
     end
 
 
+    # Return LUT, key/value store entries.
+    def lut
+        @lut
+    end
+
+
+    # Reset LUT entry or all entries.
+    def rlut( key = nil )
+        if key
+            @lut.delete key
+        else
+            @lut = {}
+        end
+    end
+
+
+    # Get value from LUT.
+    def getlut( key )
+        @lut[ key ]
+    end
+
+
+    # Set value in LUT.
+    def setlut( key, value )
+        @lut[ key ] = value
+    end
+
+
     def abs2rel( path )
         if path == @root
             ''
@@ -646,6 +672,7 @@ class Search
         @old = []
         @book = []
         @hist = []
+        @lut = {}
         update_data_sync
     end
 
@@ -760,11 +787,9 @@ class Hub
     # Kill hub.
     def kill
         @th = Thread.new do
-            STDERR.puts "Diru Hub: Exiting sooooon..."
-            sleep 3
+            STDERR.puts "Diru Hub: Killing servers ..."
             kill_servers
-            sleep 3
-            STDERR.puts "Diru Hub: Exit done..."
+            STDERR.puts "Diru Hub: Exit done ..."
             @hub.stop_service
             exit( false )
         end
@@ -805,7 +830,14 @@ class Hub
     def kill_server( s_port )
         s = @@servers[ s_port ]
         if s
-            s.kill
+            alive = s.alive?
+            cnt = 0
+            while alive && cnt < 20
+                s.kill
+                sleep 0.1
+                alive = s.alive?
+                cnt += 1
+            end
             @@servers.delete( s_port )
         else
             nil
@@ -816,9 +848,87 @@ end
 
 
 
-# diru client service (server) thread.
+# Diru client service (server) thread.
 class Service
 
+    def Service.start( hport, user, try_cnt = 3 )
+        # Setup client server.
+        hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
+
+        root = nil
+
+        # Define project root, if it is explicitly defined.
+        if ENV['DIRU_ROOT']
+            root = ENV['DIRU_ROOT']
+        else
+            # First search for .diru_root_dir file.
+            begin
+                root = File.dirname( Diru.find_upper_file( '.diru_root_dir' ) )
+            rescue
+                root = nil
+            end
+        end
+
+        opts_json = ".diru.json"
+        opts_yaml = ".diru.yml"
+
+        opts_filename = nil
+        opts_file = nil
+
+        if root
+            if Opt['options'].given
+                opts_filename = Opt['options'].value
+            elsif ENV['DIRU_OPTS']
+                opts_filename = ENV['DIRU_OPTS']
+            elsif File.exists? "#{ENV['HOME']}/#{opts_json}"
+                opts_filename = "#{ENV['HOME']}/#{opts_json}"
+            elsif File.exists? "#{ENV['HOME']}/#{opts_yaml}"
+                opts_filename = "#{ENV['HOME']}/#{opts_yaml}"
+            else
+                opts_filename = nil
+            end
+        else
+            # No explicit root, hence derive from options file (if any).
+            begin
+                file = Diru.find_an_upper_file( [ opts_json, opts_yaml ] )
+                root = File.dirname( file )
+                opts_filename = file
+            rescue
+                Diru.error "Could not find user directory root!"
+            end
+        end
+
+        if opts_filename
+            case File.extname( opts_filename )
+            when ".json"; opts_file = DiruConfJson.new( opts_filename )
+            when ".yml"; opts_file = DiruConfYaml.new( opts_filename )
+            else raise RuntimeError, "Wrong Diru configuration file format (i.e. not json or yaml)!"
+            end
+        else
+            raise RuntimeError, "Missing configuration file!"
+        end
+
+        s_port = 0
+        cnt = 0
+        while ( s_port == 0 && cnt < try_cnt )
+            begin
+                s_port = hub.get_server( root, user, opts_file )
+            rescue
+                Diru.warn "Access to Hub failed!" if cnt >= 1
+                sleep( 1 )
+            end
+            cnt += 1
+        end
+
+        if s_port == 0
+            Diru.error "Could not start server!"
+        else
+            puts "Using server port: #{s_port}..."
+        end
+
+    end
+
+
     attr_reader :root
     attr_reader :user
 
@@ -833,6 +943,11 @@ class Service
         self
     end
 
+    # Response true (if alive).
+    def alive?
+        true
+    end
+
     # Kill service.
     def kill
         @search.kill
@@ -856,235 +971,6 @@ class Service
 end
 
 
-if Opt['template'].given
-    puts %q{---
-hist:  20
-sync:  10
-dsync: 0
-favs:
-  f: dir_0/dir_0_4/dir_0_4_0
-  g: dir_1/dir_1_2
-peers:
-  - - "(.*/dir_0/.*)/dir_0_2_0"
-    - "\\1"
-  - - "(.*/dir_0/.*)/dir_0_1_0"
-    - "\\1/dir_0_1_1"
-}
-    exit( false )
-end
-
-
-# Keep in sync with README.
-if Opt['cmddoc'].given
-    STDERR.puts %q{
-Search commands:
-
-* "dr r"           - change to Project root dir.
-* "dr r <dir>"     - change to <dir> (somewhere) under Project root dir
-                     (glob).
-* "dr t <dir>"     - change to <dir> (somewhere) under current dir (glob).
-* "dr e <dir>"     - change to <dir> (somewhere) under Project root dir
-                     (regexp).
-
-Bookmark commands:
-
-* "dr b"           - display bookmarks.
-* "dr b ."         - add current dir to bookmarks.
-* "dr b !"         - reset (clear) bookmarks.
-* "dr b s <file>"  - store bookmarks to <file>.
-* "dr b l <file>"  - load  bookmarks from <file>.
-* "dr b d <num>"   - delete bookmark with <num>.
-* "dr b <num>"     - change dir to bookmark <num>.
-
-History commands:
-
-* "dr h"           - display history.
-* "dr h ."         - add current dir to history.
-* "dr h !"         - reset (clear) history.
-* "dr h 0"         - reference latest history item.
-* "dr h <num>"     - change dir to history <num>.
-
-Scratch Pad commands:
-
-* "dr s ."         - store current dir to Default Scratch Pad.
-* "dr s . <reg>"   - store current dir to <reg> in Scratch Pad.
-* "dr s <dir>"     - store <dir> to Default Scratch Pad.
-* "dr s <d> <r>"   - store <dir> to <reg> in Scratch Pad.
-* "dr s"           - change dir to Default Scratch Pad.
-* "dr s <reg>"     - change dir to <reg> from Scratch Pad.
-* "dr s ="         - display Scratch Pad content.
-* "dr s !"         - reset (clear) Scratch Pad.
-
-Misc commands:
-
-* "dr p"           - jump to peer dir, i.e. the peer of current (from options).
-* "dr c <cmd>"     - issue RPC command to server (reset etc., see below).
-* "dr f"           - list favorites dirs (from options).
-* "dr f <dir>"     - change dir to favorite <dir>.
-* "dr d m <dir>"   - make directory.
-* "dr d r <dir>"   - remove directory.
-* "dr i"           - show command info.
-* "dr <dir>"       - change to given dir (must be under current).
-* "dr"             - change to next "Left-over" directory.
-
-}
-    exit( false )
-end
-
-
-hport = nil
-if Opt['hport'].given
-    hport = Opt['hport'].value.to_i
-else
-    hport = Diru::DIRU_HUB_PORT
-end
-
-
-if Opt['hub'].given
-
-    # Hub:
-    h = Hub.start( hport, !Opt['nodaemon'].given )
-    exit( true )
-end
-
-
-if false
-    # For hub maintenance (irb):
-    require 'drb'
-    hub = DRbObject.new( nil, "druby://localhost:41114" )
-    hub.list_servers
-end
-
-
-if false
-    # Test client
-    require 'drb'
-    @port = 41115
-    @search = DRbObject.new( nil, "druby://localhost:#{@port}" )
-end
-
-
-if Opt['hkill'].given
-    begin
-        hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
-        hub.kill
-    rescue
-        Diru.error "Could not kill Hub!"
-    end
-    exit( true )
-end
-
-
-if Opt['server'].given
-
-    # Setup client server.
-    hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
-
-    root = nil
-
-    # Define project root, if it is explicitly defined.
-    if ENV['DIRU_ROOT']
-        root = ENV['DIRU_ROOT']
-    else
-        # First search for .diru_root_dir file.
-        begin
-            root = File.dirname( Diru.find_upper_file( '.diru_root_dir' ) )
-        rescue
-            root = nil
-        end
-    end
-
-    opts_json = ".diru.json"
-    opts_yaml = ".diru.yml"
-
-    opts_filename = nil
-    opts_file = nil
-
-    if root
-        if Opt['options'].given
-            opts_filename = Opt['options'].value
-        elsif ENV['DIRU_OPTS']
-            opts_filename = ENV['DIRU_OPTS']
-        elsif File.exists? "#{ENV['HOME']}/#{opts_json}"
-            opts_filename = "#{ENV['HOME']}/#{opts_json}"
-        elsif File.exists? "#{ENV['HOME']}/#{opts_yaml}"
-            opts_filename = "#{ENV['HOME']}/#{opts_yaml}"
-        else
-            opts_filename = nil
-        end
-    else
-        # No explicit root, hence derive from options file (if any).
-        begin
-            file = Diru.find_an_upper_file( [ opts_json, opts_yaml ] )
-            root = File.dirname( file )
-            opts_filename = file
-        rescue
-            Diru.error "Could not find user directory root!"
-        end
-    end
-
-    if opts_filename
-        case File.extname( opts_filename )
-        when ".json"; opts_file = DiruConfJson.new( opts_filename )
-        when ".yml"; opts_file = DiruConfYaml.new( opts_filename )
-        else raise RuntimeError, "Wrong Diru configuration file format (i.e. not json or yaml)!"
-        end
-    else
-        raise RuntimeError, "Missing configuration file!"
-    end
-
-    if Opt['server'].value.any?
-        user = Opt['server'].value[0]
-    else
-        user = ENV['USER']
-    end
-
-    begin
-        s_port = hub.get_server( root, user, opts_file )
-    rescue
-        Diru.error "Access to Hub failed!"
-    end
-
-    if s_port == 0
-        Diru.error "Could not start server!"
-    else
-        puts "Using server port: #{s_port}..."
-    end
-
-    exit( true )
-end
-
-
-if Opt['kill'].given
-
-    hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
-    port = Opt['kill'].value.to_i
-    begin
-        hub.kill_server port
-    rescue
-        Diru.error "Access to Hub failed!"
-    end
-
-    exit( true )
-end
-
-
-if Opt['list'].given
-
-    hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
-    begin
-        hub.list_servers.each do |i|
-            puts format( "%-12.d  %-12s %s", i[0], i[2], i[1] )
-        end
-    rescue
-        Diru.error "Access to Hub failed!"
-    end
-
-    exit( true )
-end
-
-
-
 # ------------------------------------------------------------
 # Client program.
 # ------------------------------------------------------------
@@ -1261,6 +1147,29 @@ class Client
                     fav_map( arg )
                 end
 
+            when 'l';
+                if arg[0] == nil
+                    @search.lut.each do |k,v|
+                        STDERR.puts "    #{k.to_s.ljust(16)} #{v}"
+                    end
+                else
+                    if arg[0] == '!'
+                        if arg.length == 1
+                            @search.rlut
+                        else
+                            @search.rlut( arg[1] )
+                        end
+                    else
+                        if arg.length == 1
+                            val = @search.getlut( arg[0] )
+                            STDERR.puts val if val
+                        else
+                            @search.setlut( arg[0], arg[1] )
+                        end
+                    end
+                end
+                no_cd
+
             when 'd';
                 # Mkdir:
                 #   dr d m <dir>
@@ -1377,6 +1286,7 @@ class Client
     p - peer of current
     c - command (reset, doc etc.)
     f - favorites
+    l - lookup key/value store
     d - directory mutation
     i - short info
     "
@@ -1434,6 +1344,218 @@ class Client
 end
 
 
+
+# ------------------------------------------------------------
+# Server (and generic) actions.
+# ------------------------------------------------------------
+
+
+if Opt['template'].given
+    puts %q{{
+    "sync": 10,
+    "dsync": 0,
+    "hist": 20,
+    "favs": {
+        "f": "dir_0/dir_0_4/dir_0_4_0",
+        "g": "dir_1/dir_1_2"
+    },
+    "peers": [
+        [
+            "(.*/dir_0/.*)/dir_0_2_0",
+            "\\\\1"
+        ],
+        [
+            "(.*/dir_0/.*)/dir_0_1_0",
+            "\\\\1/dir_0_1_1"
+        ]
+    ]
+}
+}
+    exit( false )
+end
+
+
+# Keep in sync with README.
+if Opt['cmddoc'].given
+    STDERR.puts %q{
+Search commands:
+
+dr r           - change to Project root dir.
+dr r <dir>     - change to <dir> (somewhere) under Project root dir
+                 (glob).
+dr t <dir>     - change to <dir> (somewhere) under current dir (glob).
+dr e <dir>     - change to <dir> (somewhere) under Project root dir
+                 (regexp).
+
+Bookmark commands:
+
+dr b           - display bookmarks.
+dr b .         - add current dir to bookmarks.
+dr b !         - reset (clear) bookmarks.
+dr b s <file>  - store bookmarks to <file>.
+dr b l <file>  - load  bookmarks from <file>.
+dr b d <num>   - delete bookmark with <num>.
+dr b <num>     - change dir to bookmark <num>.
+
+History commands:
+
+dr h           - display history.
+dr h .         - add current dir to history.
+dr h !         - reset (clear) history.
+dr h 0         - reference latest history item.
+dr h <num>     - change dir to history <num>.
+
+Scratch Pad commands:
+
+dr s .         - store current dir to Default Scratch Pad.
+dr s . <reg>   - store current dir to <reg> in Scratch Pad.
+dr s <dir>     - store <dir> to Default Scratch Pad.
+dr s <d> <r>   - store <dir> to <reg> in Scratch Pad.
+dr s           - change dir to Default Scratch Pad.
+dr s <reg>     - change dir to <reg> from Scratch Pad.
+dr s =         - display Scratch Pad content.
+dr s !         - reset (clear) Scratch Pad.
+
+Lookup commands:
+
+dr l           - list all lookup <key>/<v> pairs.
+dr !           - remove all keys.
+dr ! <key>     - remove <key>.
+dr l <key>     - lookup value for <key>.
+dr l <key> <v> - store value <v> for <key>.
+
+Misc commands:
+
+dr p           - jump to peer dir, i.e. the peer of current (from options).
+dr c <cmd>     - issue RPC command to server (reset etc., see below).
+dr f           - list favorites dirs (from options).
+dr f <dir>     - change dir to favorite <dir>.
+dr d m <dir>   - make directory.
+dr d r <dir>   - remove directory.
+dr i           - show command info.
+dr <dir>       - change to given dir (must be under current).
+dr             - change to next "Left-over" directory.
+
+}
+    exit( false )
+end
+
+
+hport = nil
+if Opt['hport'].given
+    hport = Opt['hport'].value.to_i
+else
+    hport = Diru::DIRU_HUB_PORT
+end
+
+
+if Opt['hkill'].given
+    begin
+        hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
+        hub.kill
+    rescue
+        Diru.error "Could not kill Hub!"
+    end
+    exit( true )
+end
+
+
+if Opt['kill'].given
+
+    hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
+    port = Opt['kill'].value.to_i
+    begin
+        hub.kill_server port
+    rescue
+        Diru.error "Access to Hub failed!"
+    end
+
+    exit( true )
+end
+
+
+if Opt['list'].given
+
+    hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
+    begin
+        hub.list_servers.each do |i|
+            puts format( "%-12.d  %-12s %s", i[0], i[2], i[1] )
+        end
+    rescue
+        Diru.error "Access to Hub failed!"
+    end
+
+    exit( true )
+end
+
+
+if false
+    # For hub maintenance (irb):
+    require 'drb'
+    hub = DRbObject.new( nil, "druby://localhost:41114" )
+    hub.list_servers
+end
+
+
+if false
+    # Test client:
+    require 'drb'
+    @port = 41115
+    @search = DRbObject.new( nil, "druby://localhost:#{@port}" )
+end
+
+
+if Opt['hub'].given
+
+    # Start Hub.
+    Hub.start( hport, !Opt['nodaemon'].given )
+
+    exit( true )
+end
+
+
+if Opt['server'].given
+
+    # Server options.
+    if Opt['server'].value.any?
+        user = Opt['server'].value[0]
+    else
+        user = ENV['USER']
+    end
+
+    # Start service.
+    Service.start( hport, user )
+
+    exit( true )
+end
+
+
+
+if Opt['start'].given
+
+    # Start Hub.
+    Hub.start( hport, !Opt['nodaemon'].given )
+
+    # Server options.
+    if Opt['server'].value.any?
+        user = Opt['server'].value[0]
+    else
+        user = ENV['USER']
+    end
+
+    # Start server.
+    Service.start( hport, user )
+
+    exit( true )
+end
+
+
+
+
+# ------------------------------------------------------------
+# Client actions.
+# ------------------------------------------------------------
+
 if Opt['port'].given
     port = Opt['port'].value.to_i
 elsif ENV['DIRU_PORT']

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Diru
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
     def Diru.version
         Diru::VERSION
     end

data/test/golden.log

@@ -273,6 +273,7 @@ Diru Warning: Dir not found!
     p - peer of current
     c - command (reset, doc etc.)
     f - favorites
+    l - lookup key/value store
     d - directory mutation
     i - short info
     
@@ -347,6 +348,7 @@ Diru Warning: Dir not found!
     p - peer of current
     c - command (reset, doc etc.)
     f - favorites
+    l - lookup key/value store
     d - directory mutation
     i - short info
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diru
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tero Isannainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: como
@@ -27,7 +27,7 @@ dependencies:
 description: |-
   Diru is a Change Directory (cd) utility for
   augmenting Unix Shell functionality. Diru makes it easy and efficient
-  to jump around in Project's directories. Diru uses server/client
+  to jump around in Project's directories. Diru uses client/server
   architecture, which enables sharing of directory info and state
   between terminal sessions.
 
@@ -37,7 +37,7 @@ description: |-
   concurrently.
 
   Client queries directory info from Server and directory change is
-  pushed to Shell in order to change the current directory within
+  pushed to Shell in order to change the current directory within the
   Shell.
 email: tero.isannainen@gmail.com
 executables: