diru 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 909b1ab4f9f1edcafd5b5a7e0e9f025663dc753c
-  data.tar.gz: 2d6cee00599bc252645141e237cf9a51e092ba2c
+  metadata.gz: 661a13ca67725be1a3bfd0346e7cf0181c143c45
+  data.tar.gz: 8e2275fadcb18e0c545e58456f2370a354bb1af2
 SHA512:
-  metadata.gz: cba95aeefd39cf86ed3c6ecce6413d8ff995bc2d85431b23f1bf8a32faa1d0ed173a5dc5f8b4569ab9001f74e695151ff4ad49d2c74d5f97feae832435b42586
-  data.tar.gz: f462f73de40bf425a332cacd7ac32d74e227e64a318bb9e97c877872e6e8b5740bb17f2f03f33d4ea0e1c67a88a04a9c28df15bc001735bb4771775ebe22ab5a
+  metadata.gz: 2e16248f4b28add940c1085a51f379a416923236d96b71bddb6b111307fb76bc52efb140aca5a0287abf0a65d17ae719778619aa9654188cd48593dbe71409c3
+  data.tar.gz: ac8d58f8815ea2b9697a6446c1d8688a7b1a60f59f74b2e8ad687f81da291c750aa244e571b4a770a4795f18aa33e1fee64cf102c6efce85a764647223fbbc92

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
 = Version history
 
+[0.0.2] Separate refresh for Options File and Project dirs.
+        Manual refresh for Options File and Project dirs.
+
 [0.0.1] Initial version.

data/README.rdoc

@@ -28,8 +28,10 @@ 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 (regexp match).
-* Find and jump to dir under current dir (regexp match).
+* Find and jump to dir under Project root (regexp search).
+* Find and jump to dir under current dir (regexp search).
+* Fast directory search since Server maintains a memory image of
+  directories.
 * Favorite directories in options (configuration), for permanent
   favorites.
 * Bookmark saving and referencing, for current favorites.
@@ -87,7 +89,10 @@ Here is an example of such function for Bourne Shell based shells:
 Diru Client command is called now "dr". We specify with "-p" 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.
+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.
 
 If you want to see all Diru options, perform:
 
@@ -181,6 +186,8 @@ RPC (Remote Procedure Call) commands:
 * "lbook" - List Bookmarks.
 * "rbook" - Reset Bookmarks.
 * "doc"   - Show command documentation.
+* "dsync" - Synchronize Projecr dir content data with Server cache.
+* "sync"  - Synchronize Options File content to Server.
 
 
 = Configuration
@@ -190,7 +197,7 @@ 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.yml is used. 
+* DIRU_OPTS - options file, if nothing, ~/.diru.yml is used.
 * DIRU_ROOT - Project root, used if ".diru_root_dir" and ".diru.yml"
   are missing.
 
@@ -219,8 +226,13 @@ An example Options file can be displayed with:
 
 Available options in Options File:
 
-* :sync - Options File and Project directory hierarchy polling period
-  (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 hierarhcy is big and/or does not change
+  (often).
 * :hist - number of entries in history (max).
 * :favs - tagged favorite dirs.
 * :peers - <regexp>,<str> pairs for peer matching (String#sub method).
@@ -232,13 +244,22 @@ After Hub has been started, user can start Server for each
 Project. Each Server runs on its own Port, and user can either define
 a Shell function for each Server with specific name, or define
 environment variable (DIRU_PORT) and change it according to
-Project. Depending on the usage pattern, user might also want to use
-the Port File.
+Project. Depending on the usage pattern, user might as well want to
+use the Port File.
 
-Each Project might benefit from specific Options File, and thus user
+Each Project could benefit from specific Options File, and thus user
 could mark the Project Root with ".diru.yml" and specify the Project
 setup there.
 
+Server caches all Project directory entries from disk to memory. This
+means that Client can quickly jump to any directory, even deep in the
+hierarchy. The target dir should be fairly accurately identified,
+otherwise the search results in too many Left-overs, which is
+impractical. Server updates the cache either peridically 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".
+
 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
 assume user starts with editing source code and has a terminal for
@@ -252,9 +273,11 @@ current dir, i.e. where program running and debugging takes place.
 
 If programming project is big enough, there might be several sub-dirs
 where source files reside. User might setup favorites to Options File,
-in order to easily reference the popular source code directories.
+in order to easily reference the popular source code directories. For
+less permanent favorites, user can use Bookmarks.
 
 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.
+directory content at each refresh cycle (by default). If ":dsync"
+Option is specified, it defines the "dsync" rate.

data/bin/diru

@@ -201,8 +201,11 @@ class Search
         # History limit.
         @histlimit = 20
 
-        # Sync period.
-        @sync = 5
+        # Sync period for options (and data if no @dsync).
+        @sync = 10
+
+        # Sync period for data.
+        @dsync = nil
 
         # Options File.
         @opts_file = opts_file
@@ -218,15 +221,22 @@ class Search
         #     @logging = true
         # end
 
-        # Initial data update.
-        update_data
-        update_conf
+        # Data update thread.
+        @th_data = nil
+
+        # Options update thread.
+        @th_opts = nil
 
         # Lock for DB access.
         @datalock = Mutex.new
+        @optslock = Mutex.new
+
+        # Initial data update.
+        update_conf
+        update_data
 
-        # Start periodic DB updates.
-        periodic_update
+        start_th_data
+        start_th_opts
     end
 
 
@@ -333,8 +343,21 @@ class Search
 
             load_conf( @opts_file )
 
+            if @conf[:dsync] && @conf[:dsync] >= 0
+                @dsync = @conf[:dsync]
+            end
+
             if @conf[:sync] && @conf[:sync] >= 1
                 @sync = @conf[:sync]
+                @dsync = @sync unless @dsync
+            end
+
+            if @dsync == 0
+                kill_th_data
+            else
+                unless @th_data
+                    start_th_data
+                end
             end
 
             if @conf[:hist] && ( @conf[:hist] >= 2 )
@@ -413,11 +436,25 @@ class Search
     def update_data_sync
         @datalock.synchronize do
             update_data
+        end
+    end
+
+
+    # Update DB with MT sync.
+    def update_opts_sync
+        @optslock.synchronize do
             update_conf
         end
     end
 
 
+    # Kill search and cleanup resources.
+    def kill
+        kill_th_data
+        kill_th_opts
+    end
+
+
     # Reset dynamic state.
     def reset 
         log "reset"
@@ -427,20 +464,45 @@ class Search
         update_data_sync
     end
 
+    # Start data thread.
+    def start_th_data
+        unless @dsync == 0
+            @th_data = Thread.new do
+                loop do
+                    # puts "data update..."
+                    sleep @dsync
+                    update_data_sync
+                end
+            end
+        end
+    end
 
-    # Update DB periodically with background thread.
-    def periodic_update
-        # Spawn More data updates.
-        @th = Thread.new do
+
+    # Kill data thread.
+    def kill_th_data
+        Thread.kill( @th_data ) if @th_data
+        @th_data = nil
+    end
+
+
+    # Start opts thread.
+    def start_th_opts
+        @th_opts = Thread.new do
             loop do
-                # puts "data update..."
                 sleep @sync
-                update_data_sync
+                update_opts_sync
             end
         end
     end
 
 
+    # Kill opts thread.
+    def kill_th_opts
+        Thread.kill( @th_opts ) if @th_opts
+        @th_opts = nil
+    end
+
+
     # Enable logging.
     def logon
         @logging = true
@@ -475,11 +537,21 @@ class Hub
     def Hub.start( port, daemon = true )
         if daemon
             p = fork do
-                Hub.new( port )
+                begin
+                    Hub.new( port )
+                rescue
+                    Diru.error "Could not start Hub!"
+                    exit( false )
+                end
             end
             Process.detach( p )
         else
-            Hub.new( port )
+            begin
+                Hub.new( port )
+            rescue
+                Diru.error "Could not start Hub!"
+                exit( false )
+            end
         end
     end
 
@@ -574,8 +646,9 @@ class Service
 
     # Kill service.
     def kill
-        @drb.stop_service
+        @search.kill
         Thread.kill( @th )
+        @drb.stop_service
     end
 
     # Start service.
@@ -596,8 +669,9 @@ end
 
 if Opt['template'].given
     puts %q{---
-:hist: 20
-:sync: 10
+:hist:  20
+:sync:  10
+:dsync: 0
 :favs:
   f: dir_0/dir_0_4/dir_0_4_0
   g: dir_1/dir_1_2
@@ -644,8 +718,12 @@ end
 
 
 if Opt['hkill'].given
-    hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
-    hub.kill
+    begin
+        hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
+        hub.kill
+    rescue
+        Diru.error "Could not kill Hub!"
+    end
     exit( true )
 end
 
@@ -958,6 +1036,8 @@ class Client
         when 'lbook'; lbook( @search.book )
         when 'rbook'; @search.rbook
         when 'doc'; doc
+        when 'sync'; @search.update_opts_sync
+        when 'dsync'; @search.update_data_sync
         else return no_cd
         end
         no_cd

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diru
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tero Isannainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: como