zeiger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c01cd920ba6af86d17bd79b07e648d5e1bb37ad2
-  data.tar.gz: d90ce8ed808e1853aad0175d6fa862d0b3ff2a29
+  metadata.gz: 7ca514e457ea27de32736575f07c6aabcd63e097
+  data.tar.gz: d01654cdb2af19a41953a1726ddf114fafc3db9e
 SHA512:
-  metadata.gz: 5c24d14cba4ac6840aa2ec817c22a608bc98a476289643bdaa6b06fcd50649f82a189f45fdc5c14ef882a7cb815bdcd900c4f387d2d3baa2f4ffeb8edb90b223
-  data.tar.gz: 491a7131fc1f5b5ba29b207d31d2c5b232ed9307650a17aecd6d9383f101debefd6f7e5366c79a2e8e456e82f3d52b3fa6c799a7282b64b4ff5ab2bd683e9aff
+  metadata.gz: 0d61f59cd5a5b1d56dee4555bddc4c3b7573c37ebb6f52aa76a09ce6f80bc7f39b2a04db0d9ac463c6cbc439db8b312ac172ae09d4c5c696853fafeb72690c04
+  data.tar.gz: 5fa8f50cbefcff8298cc2896ff4053ab81d4bc360eb5f2c3dcd94196b8d97e844a6075630fa1b34d5b589ccd1290688ad25dc98c3417c61d73c21a9bc037904b

data/.zeiger.yml

@@ -1,6 +1,6 @@
 search:
-  - bin
-  - lib
+  - "bin/**/*"
+  - "lib/**/*"
 ignore:
   - .gz$
   - .png$

data/README.md

@@ -1,30 +1,31 @@
 # Zeiger
 
-Zeiger is the German word for "pointer", "indicator", "index", "locator". This gem is built in the "index" sense : run
+Zeiger is the German word for "pointer", "indicator", "index", "locator". This gem is built in the "index" sense. To install,
 
 ```
-cd myproject
-zeiger server
+gem install zeiger
 ```
 
-and this gem will create an in-memory index of all text in the filesystem subtree rooted in the current directory.
+In a terminal, run
+
+```
+zeiger server
+```
 
-Query the index thus:
+Zeiger will open a unix-socket under `/tmp` and listen for search and file-list requests. Run this in a terminal:
 
 ```
 cd myproject
 zeiger search "muppets"
 ```
 
-This example returns one line for each line in your projects containing the word "muppets". Output is in the same format as `grep` (so you can hook it up with your emacs for quick project browsing).
+(Replace "myproject" with something meaningful!)
 
-## Installation
+Zeiger will index the current directory if it is not already indexed, then search for lines containing "muppets". Output is in the same format as `grep` (so you can hook it up with your emacs for quick project browsing).
+
+Zeiger will rescan files in the current directory every ten seconds so the index is mostly up-to-date.
 
-```
-gem install 'zeiger'
-```
 
-This is built as a standalone commandline tool ; I don't have any use-cases for integrating it directly into a larger project. But if you do, I'm all ears.
 
 ## Usage
 
@@ -32,11 +33,11 @@ This is built as a standalone commandline tool ; I don't have any use-cases for
 
 `zeiger search "foo"` writes the query to the socket and displays the result
 
-`zeiger files "xed"` asks for the list of filenames corresponding to the argument ("xed"). With no argument, return all filenames.
+`zeiger files "xed"` asks for the list of filenames corresponding to the argument ("xed"). With no argument, return all filenames. Files are sorted by length of filename. This sounds odd, but works nicely with 'completing-read in emacs: you will find the file you want in fewer keystrokes.
 
 By default, Zeiger searches only in these subdirectories : %w{ app bin config lib spec test }, and excludes filenames matching these patterns: %w{ .gz$ .png$ .jpg$ .pdf$ }.
 
-To override, create a file in your working directory with the following format:
+To override, create a file called `.zeiger.yml` in your project root with the following format:
 
 ```yaml
 search:
@@ -53,6 +54,12 @@ ignore:
   - .mpg$
 ```
 
+You should change the contents to suit your indexing needs. The `search` key is a list of regexps, zeiger will index only those files whose name matches at least one of these regexps. The `ignore` key is likewise a list of regexps, zeiger will not index any file whose name matches any of these regexps. The `ignore` rule supercedes the `search` rule.
+
+When you invoke `zeiger search ...` or `zeiger files ...`, zeiger will consider whether an index already exists for the current directory. If not, and the current directory is a project root, it will create an index for the current directory. If there is no index, and the current directory is not a project root, it moves up one directory and tries again.
+
+Zeiger considers a project root any directory containing any one of the following: `%w{ .zeiger.yml .git .hg Makefile Rakefile Gemfile build.xml }` (see `ROOT_FILES` constant in `index.rb`)
+
 
 ## Contributing
 

data/bin/zeiger

@@ -3,14 +3,13 @@
 require 'socket'
 require 'zeiger'
 
-SOCKET_NAME = "./zeiger-index"
-
+pwd     = `pwd`.strip
 command = $*[0]
 
 case command
-when "server" ; Zeiger::Server.run *$*
-when "search" ; Zeiger::QueryClient.run *$*
-when "files"  ; Zeiger::FileListClient.run *$*
+when "server" ; Zeiger::Server.new.run *$*
+when "search" ; Zeiger::QueryClient.run pwd, *$*
+when "files"  ; Zeiger::FileListClient.run pwd, *$*
 end
 
 # define file groups

data/lib/zeiger/file_info.rb

@@ -9,7 +9,7 @@ module Zeiger
     end
 
     def local_filename
-      filename.gsub(/^#{Regexp.escape dir}\//, "")
+      @_local_filename ||= filename.gsub(/^#{Regexp.escape dir}\//, "")
     end
 
     def match regex

data/lib/zeiger/file_list_client.rb

@@ -1,8 +1,11 @@
 module Zeiger
   class FileListClient
-    def self.run command, q=nil, *args
+    def self.run pwd, command, q=nil, *args
       Socket.unix(SOCKET_NAME) { |sock|
-        sock.puts("FILES: #{q}")
+        s = YAML.dump({ pwd: pwd, files: q })
+        sock.write([s.bytesize].pack("I"))
+        sock.write(s)
+
         while !sock.eof?
           puts sock.readline
         end

data/lib/zeiger/index.rb

@@ -1,14 +1,27 @@
 module Zeiger
+  INDICES = { }
+
   class Index
+    ROOT_FILES = %w{ .zeiger.yml .git .hg Makefile Rakefile Gemfile build.xml }
     NGRAM_SIZE = 3
 
-    attr_accessor :index, :dir, :includes, :ignore, :files
+    attr_accessor :index, :dir, :includes, :ignore, :files, :monitor
 
     def initialize dir
       attrs = File.exist?(".zeiger.yml") ? YAML.load(File.read ".zeiger.yml") : { }
       self.dir      = File.expand_path dir
       self.index    = Hash.new { |h, k| h[k] = [] }
       self.files    = Hash.new
+      self.monitor  = Monitor.new dir, self
+      rescan
+    end
+
+    def self.from_path path
+      raise "no path! #{path.inspect}" if path == nil || path.strip == ''
+      return INDICES[path] if INDICES[path]
+      return nil if path == '/'
+      return (INDICES[path] = new(path)) if ROOT_FILES.any? { |f| File.exist?(File.join path, f) }
+      return from_path(File.dirname path)
     end
 
     def remove_from_index file
@@ -32,19 +45,24 @@ module Zeiger
       }
     end
 
-    def exec_query regex, ngrams
-      ngrams.map { |ngram| index[ngram] }.reduce(&:&).select { |line| line.matches? regex }
-    end
+    def rescan                   ; monitor.build_index                                            ; end
+    def get_ngram_lines   ngrams ; ngrams.map { |ngram| result = index[ngram] || [] }.reduce(&:&) ; end
+    def exec_query regex, ngrams ; get_ngram_lines(ngrams).select { |line| line.matches? regex }  ; end
+    def sort_by_filename   lines ; lines.sort_by { |line| line.file.local_filename }              ; end
 
     def query txt
       puts "got query #{txt.inspect}"
-      exec_query Regexp.compile(txt), txt.ngrams(NGRAM_SIZE)
+      sort_by_filename exec_query Regexp.compile(Regexp.escape txt), txt.ngrams(NGRAM_SIZE)
     end
 
     def file_list name
-      r = Regexp.compile name
-      puts "file names matching #{r.inspect}"
-      files.values.select { |f| f.match r }
+      if name
+        r = Regexp.compile name
+        puts "file names matching #{r.inspect}"
+        files.values.select { |f| f.match r }
+      else
+        files.values
+      end.sort_by { |f| f.local_filename.length }
     end
   end
 end

data/lib/zeiger/monitor.rb

@@ -4,9 +4,19 @@ module Zeiger
 
     def initialize dir, index
       @dir, @index, @stat = dir, index, Hash.new
-      attrs = File.exist?(".zeiger.yml") ? YAML.load(File.read ".zeiger.yml") : { }
-      @includes = attrs["includes"] || %w{ app bin config lib spec test }
-      @ignore   = attrs["ignore"]   || %w{ .gz$ .png$ .jpg$ .pdf$ }
+      attrs = load_config
+      @includes = attrs["search"] || %w{ app/**/* bin/**/* config/**/* lib/**/* spec/**/* test/**/* }
+      @ignore   = attrs["ignore"] || %w{ .gz$ .png$ .jpg$ .pdf$ }
+    end
+
+    def load_config
+      conf_file = File.join dir, ".zeiger.yml"
+      if File.exist?(conf_file)
+        puts "reading config from #{conf_file.inspect}"
+        YAML.load(File.read conf_file)
+      else
+        { }
+      end
     end
 
     def ignore? filename
@@ -21,7 +31,7 @@ module Zeiger
       started = Time.now
       files = Set.new
       includes.each do |inc|
-        Dir.glob(File.join(dir, inc, "**", "*")).sort.each do |file|
+        Dir.glob(File.join(dir, inc)).sort.each do |file|
           if File.file?(file) && !ignore?(file)
             files << file
             mtime = File.stat(file).mtime

data/lib/zeiger/query_client.rb

@@ -1,8 +1,11 @@
 module Zeiger
   class QueryClient
-    def self.run command, q, *args
+    def self.run pwd, command, q, *args
       Socket.unix(SOCKET_NAME) { |sock|
-        sock.puts("SEARCH: #{q}")
+        s = YAML.dump({ pwd: pwd, search: q })
+        sock.write([s.bytesize].pack("I"))
+        sock.write(s)
+
         while !sock.eof?
           puts sock.readline
         end

data/lib/zeiger/server.rb

@@ -1,17 +1,18 @@
+require 'yaml'
+
 module Zeiger
-  class Server
-    def self.run command, *args
-      dir = File.expand_path(".")
-      z = Zeiger::Index.new dir
+  SOCKET_NAME = "/tmp/zeiger-index"
 
+  class Server
+    def run command, *args
       Thread.new do
         begin
-          puts "monitor thread"
-          monitor = Zeiger::Monitor.new dir, z
-          puts "created monitor"
           while true do
-            puts "scanning..."
-            monitor.build_index
+            indices = Zeiger::INDICES.values
+            indices.each do |index|
+              puts "scanning #{index.dir}"
+              index.rescan
+            end
             sleep 10
           end
         rescue Exception => e
@@ -20,18 +21,23 @@ module Zeiger
         end
       end
 
-      puts "query thread..."
-
       Socket.unix_server_loop(SOCKET_NAME) { |sock, client|
         puts "query thread: server loop"
         begin
-          incoming = sock.readline.strip.split(/:/, 2).map &:strip
-          case incoming[0]
-          when "SEARCH"
-            z.query(incoming[1]).each { |res| sock.puts res.to_s }
-          when "FILES"
-            z.file_list(incoming[1]).each { |f| sock.puts f.local_filename }
+          length   = sock.read(4).unpack("I")[0]
+          query    = sock.read(length)
+          incoming = YAML.load(query)
+          puts incoming.to_yaml
+
+          index = Index.from_path incoming[:pwd]
+          puts "querying index at #{index.dir}"
+
+          if incoming[:search]
+            index.query(incoming[:search]).each { |res| sock.puts res.to_s }
+          elsif incoming.key? :files
+            index.file_list(incoming[:files]).each { |f| sock.puts f.local_filename }
           end
+
         ensure
           sock.close
         end

data/lib/zeiger/version.rb

@@ -1,3 +1,3 @@
 module Zeiger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeiger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - conanite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler