diru 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa98c65075bc77ba9cc6236b44d746307be8093f4209fca37012fd5838039182
-  data.tar.gz: c6a1bb20486d300b6cb8f1f02ca392ccf8d29b69ef7ecce7178e509296012306
+  metadata.gz: 52998510ee6ded3ea6fa81a826e82e648cbffb1abf1174a985ee71627bfc2d75
+  data.tar.gz: ee3d26f1d9d6668e67e9eabe0b34402a5b5c7e477d20a6cb58f1d51da4449ab3
 SHA512:
-  metadata.gz: 1a6380ad8a79db5adce05913b296bebb0e69b578f979ecb745cbc2d1f4a51ad252e163390f358062e37ff1f024dd84ba37a227cf11bad36a43dda0376dee8051
-  data.tar.gz: fe44d2598ed43e88774fff50ce480b21b8d79dfe773db27e260f2224d468260536f1a1a6a8c9b8609eef5735abedcfcfb21ac9bf1657390dd9630f1ff283010a
+  metadata.gz: f4dbaef3dc53c31010493374b2feefd8c15f01a2e1cbfac777ccee14e7488208b3f27c195abd2ce4d51d5ebfe34493bba734551d4ef6ff9b2cbe4bae8ac6a9ff
+  data.tar.gz: bb18dc7513830cfbbf4b2b33ef07aa084ccb2b44c4f01ba3b722b81c4d4c60f29b4f82a82d181302acd0847401738542436f08f6eebd62da8e9da87dc49bd3b1

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Version history
 
+[0.1.1] Prefering string keys for config.
+        Prefer json over yaml for options.
+        Deprecated DIRU_OPTS_FORMAT env var.
+
 [0.1.0] Fast startup after server start.
         Support for JSON options format.
 

data/README.rdoc

@@ -75,10 +75,8 @@ 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. Json format is selected by defining the DIRU_OPTS_FORMAT
-environment variable as "json". The default is "yml". If no files are
-found and DIRU_ROOT environment variable is not used, an error is
-issued.
+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
@@ -230,7 +228,6 @@ provides thereby backup values for non-specified command line info.
 * 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_OPTS_FORMAT - Options file format: yml or json. Default is yml.
 
 If Hub is started without "--hport" option, Diru checks if
 DIRU_HUB_PORT is defined. If not, port 41114 is used.
@@ -251,6 +248,9 @@ 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.
 
+The "json" format is searched before "yml" format, and hence "json" is
+selected if both exist.
+
 An example Options file can be displayed with:
 
     shell> diru -t
@@ -258,20 +258,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
@@ -313,7 +313,7 @@ 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
+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"
+directory content at each refresh cycle (by default). If "dsync"
 Option is specified, it defines the "dsync" rate.

data/bin/diru

@@ -145,14 +145,40 @@ module Diru
     end
 
 
-    # Find file entry from directory hierarchy upwards, exit if not found.
-    def Diru.must_find_upper_file( file, dir = Dir.pwd )
-        begin
-            Diru.find_upper_file( file, dir )
-        rescue RuntimeError
-            STDERR.puts "Could not find file \"#{file}\"!"
-            exit( false )
+    # Find file entry from directory hierarchy upwards.
+    def Diru.find_an_upper_file( files, dir = Dir.pwd )
+        found = nil
+
+        # Process all directory levels.
+        while true
+
+            # Process directory level.
+            while true
+                # Process all files per directory level.
+                idx = 0
+                files.each do |file|
+                    match = Dir.glob( "#{dir}/#{file}" )
+                    unless match.empty?
+                        found = match[0]
+                        break
+                    end
+                end
+
+                break if found
+
+            end
+
+            break if found
+
+            if dir == "/"
+                raise RuntimeError, "Could not find file(s): \"#{files.join("\", \"")}\"!"
+            end
+
+            dir = File.dirname( dir )
+
         end
+
+        found
     end
 
 
@@ -170,32 +196,18 @@ end
 # Diru configuration file.
 class DiruConf
 
-    def DiruConf.deploy( filename = nil )
-        dc_file = DiruConf.find( filename )
-        DiruConf.use( dc_file )
-    end
-
-    def DiruConf.find( filename = nil )
-        opts_file = nil
-        if Opt['options'].given
-            opts_file = Opt['options'].value
-        elsif filename
-            opts_file = filename
-        elsif ENV['DIRU_OPTS']
-            opts_file = ENV['DIRU_OPTS']
-        else
-            opts_file = "#{ENV['HOME']}/#{Diru.opts_filename}"
-        end
-
-        opts_file
-    end
-
-    def DiruConf.use( filename )
-        case File.extname( filename )
-        when ".json"; DiruConfJson.new( filename )
-        when ".yml"; DiruConfYaml.new( filename )
-        else raise RuntimeError, "Wrong Diru configuration file format (i.e. not json or yaml)!"
+    # Convert YAML config to hash with String keys at highest level.
+    def DiruConf.stringify_yaml_keys( entry )
+        ret = {}
+        entry.each do |k,v|
+            if k.is_a? String
+                key = k
+            else
+                key = k.to_s
+            end
+            ret[ key ] = v
         end
+        ret
     end
 
     def initialize( filename )
@@ -210,7 +222,7 @@ class DiruConfJson < DiruConf
 
     def load
         if File.exist?( @filename )
-            JSON.parse( File.read( @filename ), :symbolize_names => true )
+            JSON.parse( File.read( @filename ) )
         else
             STDERR.puts "Diru Error: Broken JSON, please fix: \"#{@filename}\"..."
             nil
@@ -225,7 +237,7 @@ class DiruConfYaml < DiruConf
 
     def load
         if File.exist?( @filename )
-            YAML.load( File.read( @filename ) )
+            DiruConf.stringify_yaml_keys( YAML.load( File.read( @filename ) ) )
         else
             STDERR.puts "Diru Error: Broken YAML, please fix: \"#{@filename}\"..."
             nil
@@ -421,12 +433,12 @@ class Search
 
             return unless load_conf( @opts_file )
 
-            if @conf[:dsync] && @conf[:dsync] >= 0
-                @dsync = @conf[:dsync]
+            if @conf[ "dsync" ] && @conf[ "dsync" ] >= 0
+                @dsync = @conf[ "dsync" ]
             end
 
-            if @conf[:sync] && @conf[:sync] >= 1
-                @sync = @conf[:sync]
+            if @conf[ "sync" ] && @conf[ "sync" ] >= 1
+                @sync = @conf[ "sync" ]
                 @dsync = @sync unless @dsync
             end
 
@@ -438,14 +450,14 @@ class Search
                 end
             end
 
-            if @conf[:hist] && ( @conf[:hist] >= 2 )
-                @histlimit = @conf[:hist]
+            if @conf[ "hist" ] && ( @conf[ "hist" ] >= 2 )
+                @histlimit = @conf[ "hist" ]
             else
                 @histlimit = 20
             end
 
-            if @conf[ :favs ]
-                @fav = @conf[ :favs ]
+            if @conf[ "favs" ]
+                @fav = @conf[ "favs" ]
             end
 
         end
@@ -846,13 +858,13 @@ end
 
 if Opt['template'].given
     puts %q{---
-:hist:  20
-:sync:  10
-:dsync: 0
-:favs:
+hist:  20
+sync:  10
+dsync: 0
+favs:
   f: dir_0/dir_0_4/dir_0_4_0
   g: dir_1/dir_1_2
-:peers:
+peers:
   - - "(.*/dir_0/.*)/dir_0_2_0"
     - "\\1"
   - - "(.*/dir_0/.*)/dir_0_1_0"
@@ -969,8 +981,8 @@ if Opt['server'].given
     hub = DRbObject.new( nil, "druby://localhost:#{hport}" )
 
     root = nil
-    opts_file = nil
 
+    # Define project root, if it is explicitly defined.
     if ENV['DIRU_ROOT']
         root = ENV['DIRU_ROOT']
     else
@@ -980,22 +992,46 @@ if Opt['server'].given
         rescue
             root = nil
         end
+    end
 
-        unless root
+    opts_json = ".diru.json"
+    opts_yaml = ".diru.yml"
 
-            # Next search for .diru.[json|yml] file.
-            begin
-                file = Diru.find_upper_file( Diru.opts_filename )
-                root = File.dirname( file )
-                opts_file = file
-            rescue
-                Diru.error "Could not find user directory root!"
-            end
+    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
 
-    # opts_file = Diru.get_opts_file( opts_file )
-    opts_file = DiruConf.deploy( opts_file )
+    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]
@@ -1012,7 +1048,6 @@ if Opt['server'].given
     if s_port == 0
         Diru.error "Could not start server!"
     else
-        # File.write( port_file, s_port.to_s ) if port_file
         puts "Using server port: #{s_port}..."
     end
 
@@ -1318,7 +1353,7 @@ class Client
     def peer
         # cur = Dir.pwd
         cur = @pwd
-        peers = @conf[ :peers ]
+        peers = @conf[ "peers" ]
         peers.each do |pair|
             re = Regexp.new( pair[0] )
             if ( re.match( cur ) )

data/lib/version.rb

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

metadata

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