working_set 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8d080e5e195b802c64757728b39a21a747e029c9a067bd523a115208aed4038
+  data.tar.gz: b02705986887a8ff43aeb8945e3356032f97b2ed6e05458f4438e2b55e1f5ded
+SHA512:
+  metadata.gz: b5699a5b2f85909e67ec262ed787ba94e47015874fb4e931b0bd646229bb09ae8b1737705273d3152bcbc54dabda3a50adc3033c49332c4d2133cd03c1e5963a
+  data.tar.gz: 119b23428f7bbbae2025c186371c0a857927cd58230b153c6b327c77d0234b17054a50ae81760d8e9f8b27554dcea8f7cef73be61db0f99838cacecbfa354c1a

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/
+working_set.log

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/API_FOR_EDITOR_INTEGRATION.md

@@ -0,0 +1,97 @@
+# API for Editor Integration
+
+Most advanced text editors can be extended with plugins and other
+customizations.  Working Set was built to be a companion to your text editor.
+Since the original author of Working Set uses Vim, that's the first editor
+integration that was created.
+
+At time of writing, it's also the only one that exists.
+
+Should someone wish to integrate another editor, e.g. Emacs, this is the
+information they'd need to know.
+
+## Overview
+
+When `working_set` (WS) starts, it creates a socket file in the current
+directory (named `.working_set_socket` by default). WS listens to the socket for
+`message`s.  When it receives a `message`, it will asyncronously perform whatever
+task is required, and then (possibly) send a `message` as a response to the
+client via the socket file.
+
+You can see a working client implementation in the [Vim
+plugin](https://github.com/coderifous/working-set.vim).
+
+## Message Format
+
+Messages to Working Set are serialized JSON and have these keys:
+
+    message: a single word, often a command
+
+    args:    optional object, specific to a command.
+
+    options: optional object, specific to a command.
+
+Replies from Working Set will be similiar, always having a `message` key, but
+additional keys may vary.
+
+## Messages from Client to Server (Working Set)
+
+#### search_changed
+
+This message tells Working Set to update the search results.
+
+Examples:
+
+    { "message": "search_changed", "args": "foo" }
+
+    { "message": "search_changed", "args": "foo", "options": { "whole_word": true } }
+
+#### select_next_item, et al
+
+This message tells Working Set to select the next item in the list.  There are a
+few similar messages.
+
+Example:
+
+    { "message": "select_next_item" }
+
+Similar messages:
+* select_prev_item
+* select_next_file
+* select_prev_file
+
+### tell_selected_item
+
+Working Set will respond to this message with a "selected_item" message.
+
+### tell_selected_item_content
+
+Working Set will respond to this message with a "selected_item_content" message.
+
+### show_match_lines_toggled
+
+Working Set will toggle whether match lines are showed.
+
+### refresh
+
+Working Set will re-run the current search and update results.
+
+## Messages from Server to Client (editor)
+
+### selected_item
+
+Example:
+
+    { "message": "selected_item", "file_path": "app/foo.rb", "row": 1, "column": 10 }
+
+Clients can do whatever they want when they recieve this message, one useful
+response might be to jump to the specified file and location.
+
+### selected_item_content
+
+Example:
+
+    { "message": "selected_item_content", data: "foo bar baz" }
+
+Clients can do whatever they want when they recieve this message, one useful
+response might be to insert the requested content where the user is typing.

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change log
+
+## [v1.0.1] - 2020-09-07
+
+### Fixed
+* Fix issue with scrolling via up/down arrows
+* Fix issue with preserving whole_word option on refresh
+
+## [v1.0.0] - 2020-09-05
+
+### Initial Release
+* Refactoring and prep for release.
+* Features search and navigation features.
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in working_set.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jim Garvin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# working_set
+
+Companion to your editor that makes searching, and using search results for
+jumping around, super nice.
+
+## Installation
+
+Installing the gem adds the working_set command to your path.
+
+    $ gem install working_set
+
+Install the plugin for your editor.
+
+* [Vim Plugin](https://github.com/coderifous/working-set.vim)
+
+Note: Currently there's only a plugin for Vim, however Working Set will be
+compatible with any editor that can be extended and communicate via socket.
+
+## Usage
+
+Run the working_set command in your project's directory.
+
+    $ cd my-project
+    $ working_set
+
+working_set is now running, listening on a file socket, ready to receive
+commands from your text editor which you should run in a separate terminal but
+in the same directory.
+
+    $ cd my-project
+    $ vim
+
+## Options
+
+Run `working_set -h` to see a list of command line options:
+
+    --watch | -w
+
+      Tells working_set to monitor the filesystem for changes and refresh the
+      search results automatically when changes are detected.  The value should be
+      point at the directory you want to monitor.
+
+      Example: --watch=app
+
+      Default: none, search results will not automatically refresh.
+
+    --context | -c
+
+      Sets number of contextual lines to show around matches.
+
+      Example: --count=3
+
+      Default: 1
+
+    --socket | -s
+
+      Sets the path for the socket file to create.
+
+      Example: --socket=/tmp/my-special-project
+
+      Default: .working_set_socket
+
+    --help | -h
+
+      Show help.
+
+## Commands in working_set
+
+You can press '?' in working_set to see key bindings:
+
+    ?          - display help
+    q          - quit
+    j          - select next match
+    k          - select previous match
+    ctrl-n     - select first match in next file
+    ctrl-p     - select first match in previous file
+    enter      - Tell editor to jump to match
+    down arrow - scroll down without changing selection
+    up arrow   - scroll up without changing selection
+    r          - refresh search results
+    [          - decrease context lines
+    ]          - increase context lines
+    z          - toggle showing match lines vs just matched files
+    y          - copy selected match to system clipboard
+    Y          - copy selected match + context to system clipboard
+
+## Todo
+* Add support for searching straight from working_set using "/" key.
+* Add support for setting search argument prefix as working_set command argument.
+  e.g. --prefix="--ignore=tmp,vendor"
+* Add support for bookmarks.
+* Add support for search history.
+* Add support for customizing key bindings.
+* Document protocol so other plugin editors can exist.
+* Document adapter so other search tools can be used.
+
+## Development
+
+1) Fork the repo, clone the source code.
+2) run `bundle install` to install dependencies.
+3) run `bin/working_set -d` to execute the program with debug logging enabled
+4) watch the debug messages: `tail -f working_set.log`
+5) make code changes, restart `working_set` to see their effect.
+
+Please do submit pull requests to add features, fix bugs, etc. Please discuss
+before spending lots of time on large changes.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/working_set

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "working_set_cli.rb"

data/lib/api_input_actor.rb

@@ -0,0 +1,75 @@
+require 'socket'
+require 'json'
+
+class ApiInputActor
+  include BasicActor
+  include Celluloid::IO
+
+  finalizer :close_server
+
+  # Since the inputs are translated into internal actor messages, we can have a
+  # little extra security by only permitting certain messages, because some
+  # messages are really for internal use only.
+  PERMITTED_MESSAGES_LIST = %w(
+    search_changed
+    select_next_item
+    select_prev_item
+    select_next_file
+    select_prev_file
+    tell_selected_item
+    tell_selected_item_content
+    show_match_lines_toggled
+    refresh
+  )
+
+  def initialize
+    subscribe "respond_client", :respond_client
+    @server = UNIXServer.new $SOCKET_PATH
+    async.watch_input
+  end
+
+  def watch_input
+    loop do
+      @client = @server.accept
+      while input = @client.gets
+        process_input(input.chomp)
+      end
+      @client.close
+    end
+  end
+
+  def process_input(input)
+    debug_message "input: #{input.inspect}"
+
+    parsed = JSON.parse(input)
+    message = parsed["message"]
+    args    = parsed["args"]
+    options = parsed["options"]
+
+    debug_message "message: #{message.inspect}\nargs: #{args.inspect}\noptions: #{options.inspect}"
+
+    unless PERMITTED_MESSAGES_LIST.include?(message)
+      debug_message "Message not permitted, ignoring."
+      return
+    end
+
+    publish *[message, args, options].compact
+  end
+
+  def close_server
+    debug_message "closing server" if @server
+    @server.close if @server
+    File.delete($SOCKET_PATH)
+  end
+
+  def respond_client(_, message, extras={})
+    payload = { message: message }.merge(extras)
+    debug_message "Responding #{payload.inspect}"
+    @client.puts payload.to_json if @client
+  end
+
+  def send_message(msg, arg)
+    debug_message "Sending #{msg}, #{arg}"
+    @client.puts [msg, arg].join("|") if @client
+  end
+end

data/lib/basic_actor.rb

@@ -0,0 +1,8 @@
+module BasicActor
+
+  def self.included(includer)
+    includer.include Celluloid
+    includer.include Celluloid::Notifications
+  end
+
+end

data/lib/colors.rb

@@ -0,0 +1,16 @@
+if defined?(Ncurses)
+  Colors = {
+    blue:  { pair: [Ncurses::COLOR_BLUE, -1] },
+    cyan:  { pair: [Ncurses::COLOR_CYAN, -1] },
+    red:   { pair: [Ncurses::COLOR_RED, -1] },
+    white: { pair: [Ncurses::COLOR_WHITE, -1] },
+    green: { pair: [Ncurses::COLOR_GREEN, -1] },
+    yellow: { pair: [Ncurses::COLOR_YELLOW, -1] }
+  }
+
+  Colors.each_with_index do |(k,v),i|
+    v[:number] = i + 1
+  end
+end
+
+API_PORT_NUMBER = 3930

data/lib/live_updater_actor.rb

@@ -0,0 +1,29 @@
+require 'listen'
+
+class LiveUpdaterActor
+  include BasicActor
+
+  finalizer :stop
+
+  def initialize
+    @listener = build
+    start
+  end
+
+  def build
+    Listen.to($LIVE_UPDATE_WATCH_PATH) do |modified, added, removed|
+      debug_message "modified absolute path: #{modified}"
+      debug_message "added absolute path: #{added}"
+      debug_message "removed absolute path: #{removed}"
+      publish "refresh"
+    end
+  end
+
+  def start
+    @listener.start
+  end
+
+  def stop
+    @listener.stop
+  end
+end

data/lib/set_builder_actor.rb

@@ -0,0 +1,23 @@
+class SetBuilderActor
+  include BasicActor
+
+  attr_accessor :adapter
+
+  DEFAULT_ADAPTER_CLASS = SetBuilderAdapter::Ag
+
+  def initialize(initial_adapter = DEFAULT_ADAPTER_CLASS.new)
+    subscribe "search_changed", :build_working_set
+    self.adapter = initial_adapter
+  end
+
+  def build_working_set(_, search, options={})
+    debug_message "search: #{search.inspect} options: #{options.inspect}"
+    begin
+      working_set = adapter.build_working_set(search, options)
+      publish "set_build_finished", working_set
+    rescue StandardError => e
+      publish "set_build_failed", e
+    end
+  end
+
+end