omnibar 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ac95e6ea1b99df44bf41c79f7a3790b3f579753
-  data.tar.gz: 3d3b992d0cd08ae4e45f6e6df63b8de5ad9a2af3
+  metadata.gz: 513b1e361992c5857eeb37e52f0a0d2c52486d99
+  data.tar.gz: da3effe0d3c63a840d6294b97df44f1d0598835b
 SHA512:
-  metadata.gz: aad77472a565a347b6b9ae4db75294b9f3976ae515be84e5a17d2f40cc9075c1c96904a732694d838d2d76a237c80912afa2b96fc16866c04e8041d1c5881b06
-  data.tar.gz: 779c6a126717a08620abf45d43575d32a3900c30119c25c38d5c723a7a6577750b783479527d8799b5c4cd6c175b6a2f7a3534c2f9866b9537d85ecd9401f55b
+  metadata.gz: 2b372c0dde29e27c51d2e566ddd7f1a86de1dfe4487e29aff65c5d532882d6f539a6157bc1f791ab3f3bdd04dd70dcd3d7f39bb1ab955465ba5c705a0e5209d7
+  data.tar.gz: 4ed39d98bf94668617a15609daf02d1bf023f8a3f7c9759b4edbd41b685ad65adb400f02d6106793f3a7db436eb329c159b43914e1c892dc86d5a6abfbd5f28d

data/README.md

@@ -14,7 +14,25 @@ Install as:
 
 ## Usage
 
-Run `bin/omnibar` and start typing. Use the arrow keys to select the result you like, and press enter to go!
+Run `omnibar` and start typing. Use the arrow keys to select the result you like, and press enter to go!
+
+Read about an optimal omnibar setup in the wiki: [Omnibar & i3](https://github.com/shreve/omnibar/wiki/Omnibar-&-i3)
+
+## Queries
+
+Omnibar is powered by queries. These are the built-in ones:
+
+| Name | Description |
+|------|-------------|
+| Calculate | Evaluate math expressions (powered by Math module) |
+| Emoji | Search for emojis by name |
+| Spell | Fuzzy search for the correct spelling of a word |
+| System | Run system commands like sleep, reboot, and shutdown |
+| Snippet | Access named user-provided snippets |
+| GitHub | Access user-provided GitHub repos, or quick open a repo |
+| Popular | Access user-provided popular websites |
+| DuckDuckGo | Search via Duck Duck Go |
+| Google | Search via Google |
 
 ## Configuration
 
@@ -30,21 +48,49 @@ end
 
 | Config Key | Type | Default |
 |------------|------|---------|
+| queries    | Array | Every class that inherits from Query |
 | github.repos | Array | `[]` |
+| popular.sites | Array | `[]` |
+| snippets | Hash | `{ 'shrug' => '¯\_(ツ)_/¯' }` |
 | render.prompt | Lambda / String | `->(width) { ('-' * width) << '>' }` |
 | render.highlight.fg | Symbol | `:black` |
 | render.highlight.bg | Symbol | `:yellow` |
+| events.after_start | Lambda | `-> {}` |
 | events.after_perform | Lambda | `-> {}` |
 
+Create your own queries by adding the code to your config file. Your class simply needs to extend from `Omnibar::Query`
+
+```ruby
+class MyQuery < Omnibar::Query
+  def result
+    # The string that should be displayed inside the preview
+    # If this is null, the query won't be included
+
+    input # The current input value
+  end
+
+  def perform!
+    # Execute the query
+
+    copy_to_clipboard input
+    open_in_browser "https://#{input}"
+  end
+end
+```
+
+If you think other people might like your query, please feel free to submit a pull reqest. I'm open to including any good ideas.
+
+If you don't want a query to run, delete it from `Omnibar.queries`.
+
 ## OS Limitations
 
 This gem has been developed on Ubuntu, and should work on most linux distributions.
 All the code is in ruby, but there are several dependencies that are linux-only.
 
-| Library | Usage |
-|---------|-------|
-| xdg-open | Opening urls and files |
-| GNU aspell | Spell checking and suggestions |
+| Library | Usage | Notes |
+|---------|-------|-------|
+| xdg-open | Opening urls and files |  |
+| GNU aspell | Spell checking and suggestions | Possibly installable on OS X using homebrew |
 
 ## Contributing
 

data/lib/ansi.rb

@@ -0,0 +1,58 @@
+# This module contains helpers for various ansi-code operations
+module ANSI
+  # ANSI color escape codes set the foreground and background colors.
+  # Forground color is a number between 30 and 37.
+  # Background color is a number between 40 and 47.
+  # The ones place represents the same color for both.
+  COLORS = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, 'white', nil, :white].freeze
+
+  def self.clear_screen
+    $stdout.write "\e[2J"
+  end
+
+  def self.move_cursor(row, col)
+    $stdout.write "\e[#{row + 1};#{col + 1}H"
+  end
+
+  def self.shift_cursor(rows: 0, cols: 0)
+    pos = position
+    row = pos[:row] + rows
+    col = pos[:column] + cols
+    move_cursor(row, col)
+  end
+
+  def self.color(text, fg: :white, bg: :black)
+    fg = COLORS.index(fg) + 30
+    bg = COLORS.index(bg) + 40
+    code = "\e[#{[fg, bg].compact.join(';')}m"
+    "#{code}#{text}\e[0m"
+  end
+
+  def self.reset
+    "\e[0m"
+  end
+
+  def self.position
+    res = ''
+    $stdin.raw do |stdin|
+      $stdout << "\e[6n"
+      $stdout.flush
+      while (c = stdin.getc) != 'R'
+        res << c if c
+      end
+    end
+    m = res.match(/(?<row>\d+);(?<column>\d+)/)
+    {
+      row: m[:row].to_i,
+      column: m[:column].to_i
+    }
+  end
+
+  def self.size
+    win = IO.console.winsize
+    {
+      height: win[0],
+      width: win[1]
+    }
+  end
+end

data/lib/omnibar.rb

@@ -3,22 +3,20 @@ require 'dry-configurable'
 require 'fuzzy_match'
 require 'amatch'
 
-require 'omnibar/version'
-require 'omnibar/app'
-
-require 'omnibar/calculate'
-require 'omnibar/emoji'
-require 'omnibar/spell'
-require 'omnibar/system'
-require 'omnibar/snippet'
-require 'omnibar/github'
-require 'omnibar/popular'
-require 'omnibar/duck_duck_go'
-require 'omnibar/google'
+require_relative 'ansi'
+
+require_relative 'omnibar/version'
+require_relative 'omnibar/app'
+require_relative 'omnibar/query'
+require_relative 'omnibar/renderer'
+require_relative 'omnibar/state'
+require_relative 'omnibar/view'
 
 module Omnibar
   extend Dry::Configurable
 
+  setting :queries, []
+
   setting :github do
     setting :repos, []
   end
@@ -27,14 +25,10 @@ module Omnibar
     setting :sites, []
   end
 
-  setting :spell do
-    setting :dict, '/usr/share/dict/american-english'
-  end
-
   setting :snippets, 'shrug' => '¯\_(ツ)_/¯'
 
   setting :render do
-    setting :prompt, ->(width) { ('-' * width) << '>' }
+    setting :prompt, ->(width) { (' ' * width) << ANSI.color('★', fg: :magenta) }
 
     setting :highlight do
       setting :fg, :black
@@ -43,6 +37,7 @@ module Omnibar
   end
 
   setting :events do
+    setting :after_start, ->(app) {}
     setting :after_perform, -> {}
   end
 
@@ -53,3 +48,11 @@ module Omnibar
 end
 
 FuzzyMatch.engine = :amatch
+
+# Require all the queries
+dir = File.join(File.dirname(File.expand_path(__FILE__)), 'omnibar/queries')
+Dir["#{dir}/*.rb"].each { |file| require file }
+
+# Move fallback queries to the end
+Omnibar.config.queries << Omnibar.config.queries.delete(Omnibar::DuckDuckGo)
+Omnibar.config.queries << Omnibar.config.queries.delete(Omnibar::Google)

data/lib/omnibar/app.rb

@@ -2,25 +2,12 @@
 
 require 'io/console'
 
-require_relative 'ansi'
-require_relative 'query'
-require_relative 'renderer'
-
 module Omnibar
   class App
-    attr_accessor :input
-    attr_accessor :selection
-
-    @@queries = []
-
-    def self.add_query(query)
-      @@queries.push(query)
-    end
-
     def initialize
-      @input = ''
-      @selection = 0
+      reset_state!
       Omnibar.load_config
+      Omnibar.config.events.after_start.call(self)
     end
 
     def run
@@ -35,7 +22,9 @@ module Omnibar
     end
 
     def render
-      Renderer.new(input, results, selection).render!
+      previous = @current_view
+      @current_view = View.new(@state)
+      Renderer.new(@state).render_diff(previous, @current_view)
     end
 
     def handle_input(prefix = '')
@@ -44,42 +33,36 @@ module Omnibar
       when "\u0003" # ctrl-c
         quit
       when "\u007F" # backspace
-        self.input = input[0..-2]
+        @state.backspace
       when "\e", "\e["
         handle_input(char)
-      when "\e[A"
-        self.selection = [selection - 1, 0].max
-      when "\e[B"
-        self.selection = [selection + 1, visible_queries.count - 1].min
+      when "\e[A" # Up Arrow
+        @state.select_up
+      when "\e[B" # Down Arrow
+        @state.select_down
+      when "\e[C"
+        @state.move_cursor_left
+      when "\e[D"
+        @state.move_cursor_right
       when "\e\e"
-        self.input = ""
+        reset_state!
       when "\r"
         perform_action!
+        reset_state!
       else
-        input << char
+        @state.add_to_input(char)
       end
     end
 
-    def results
-      return [] if input.empty?
-
-      queries.map(&:preview_text).compact
+    def reset_state!
+      @state = State.new
     end
 
     def perform_action!
-      visible_queries[selection]&.perform!
-      self.input = ""
+      @state.current_query.perform!
       Omnibar.config.events.after_perform.call
     end
 
-    def queries
-      @@queries.map { |q| q.new(input) }
-    end
-
-    def visible_queries
-      queries.reject { |q| q.preview_text.nil? }
-    end
-
     def quit
       ANSI.clear_screen
       exit 0

data/lib/omnibar/{emoji.rb → queries/emoji.rb}

@@ -2,6 +2,7 @@ module Omnibar
   class Emoji < Query
 
     def result
+      return if input.empty?
       key = search.find(input)
       value = DICTIONARY[key]
 

data/lib/omnibar/query.rb

@@ -1,33 +1,40 @@
 module Omnibar
   class Query
-
     attr_reader :input
 
     def initialize(input)
-      @input = input
+      @input = input.strip
     end
 
     def self.inherited(subclass)
-      Omnibar::App.add_query(subclass)
+      Omnibar.config.queries.push(subclass)
       super(subclass)
     end
 
+    # TODO: Convert result to class
+    # TODO: Allow multiple results per query
     def preview_text
       res = result
-      name = self.class.name.split('::').last
-      [name, res] unless result.nil? || result.empty?
+      name = self.class.name.split('::').last.gsub(/[A-Z]/) { |w| ' ' << w }.strip
+      [name, res.strip] unless res.nil? || res.empty?
     end
 
     def result
       input
     end
 
+    def perform!; end
+
     def copy_to_clipboard(value)
       `echo "#{value}" | xsel -i --clipboard`
     end
 
     def open_in_browser(url)
-      Thread.new { `xdg-open "#{url}" >/dev/null 2>&1` }
+      Thread.new { run_silently 'xdg-open', url }
+    end
+
+    def run_silently(*command)
+      `#{command.join(' ')} >/dev/null 2>&1`
     end
   end
 end

data/lib/omnibar/renderer.rb

@@ -1,60 +1,30 @@
 module Omnibar
   class Renderer
-    NON_ASCII_REGEX = /[^\x00-\x7F]/.freeze
-
-    attr_reader :input, :results, :selection
-
-    def initialize(input, results, selection)
-      @input = input
-      @results = results
-      @selection = selection
+    def initialize(state)
+      @state = state
     end
 
-    def render!
+    def render(view)
       ANSI.clear_screen
       ANSI.move_cursor(0, 0)
-      puts input_line
-      ANSI.move_cursor(1, 0)
-      results.each.with_index do |result, i|
-        text = [
-          lpad(result.first, max_label_length),
-          rpad(result.last, ANSI.size[:width] - max_label_length - 2)
-        ].join(': ')
-
-        if i == selection
-          text = ANSI.color(text,
-                            fg: Omnibar.config.render.highlight.fg,
-                            bg: Omnibar.config.render.highlight.bg)
-        end
-        print "#{text}\r\n"
-      end
-      ANSI.move_cursor(0, input_line.length)
+      print view.render.join("\e[2K \r\n")
+      print view.cursor_position
     end
 
-    def input_line
-      prompt = Omnibar.config.render.prompt
-      if prompt.respond_to?(:call)
-        prompt = prompt.call(max_label_length)
-      end
-      "#{prompt} #{input}"
-    end
+    def render_diff(previous, current)
+      return render(current) if previous.nil?
 
-    def rpad(text, length = ANSI.size[:width])
-      textlength = text.length + non_ascii_chars(text).length
-      text + (' ' * [0, (length - textlength)].max)
-    end
-
-    def lpad(text, length = ANSI.size[:width])
-      textlength = text.length + non_ascii_chars(text).length
-      (' ' * [0, (length - textlength)].max) + text
-    end
+      lines = [previous.length, current.length].max
+      lines.times.each do |i|
+        next if previous[i] == current[i]
 
-    def max_label_length
-      @mll ||= results.map(&:first).map(&:length).max || 10
-    end
+        ANSI.move_cursor(i, 0)
+        print "\e[2K"
+        print current[i]
+      end
 
-    def non_ascii_chars(string)
-      string.chars.select { |c| c.match?(NON_ASCII_REGEX) }
+      ANSI
+      print current.cursor_position
     end
   end
 end

data/lib/omnibar/state.rb

@@ -0,0 +1,53 @@
+module Omnibar
+  class State < Struct.new(:input, :selection, :cursor_offset)
+    def initialize(values = {})
+      self.input = ''
+      self.selection = self.cursor_offset = 0
+
+      values.each_pair do |attr, val|
+        send(:"#{attr}=", val)
+      end
+    end
+
+    def add_to_input(string)
+      self.input = input.insert(input.length - cursor_offset, string)
+    end
+
+    def backspace
+      input.slice!(input.length - 1 - cursor_offset)
+    end
+
+    def select_up
+      self.selection = [selection - 1, 0].max
+    end
+
+    def select_down
+      self.selection = [selection + 1, visible_queries.count - 1].min
+    end
+
+    def move_cursor_left
+      self.cursor_offset = [0, cursor_offset - 1].max
+    end
+
+    def move_cursor_right
+      self.cursor_offset = [input.length, cursor_offset + 1].min
+    end
+
+    def queries
+      Omnibar.config.queries.map { |q| q.new(input) }
+    end
+
+    def visible_queries
+      (@qc ||= {})[input] ||= queries.reject { |q| q.preview_text.nil? }
+    end
+
+    def current_query
+      visible_queries[selection] || Query.new
+    end
+
+    # TODO: Sort results based on relevance / certainty
+    def results
+      visible_queries.map(&:preview_text)
+    end
+  end
+end

data/lib/omnibar/version.rb

@@ -1,3 +1,3 @@
 module Omnibar
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/lib/omnibar/view.rb

@@ -0,0 +1,69 @@
+module Omnibar
+  class View
+    NON_ASCII_REGEX = /[^\x00-\x7F]/.freeze
+
+    def initialize(state)
+      @state = state
+    end
+
+    def [](line)
+      render[line]
+    end
+
+    def length
+      render.length
+    end
+
+    def render
+      @render ||= [
+        input_line,
+        *rendered_queries
+      ]
+    end
+
+    def input_line
+      prompt = Omnibar.config.render.prompt
+      prompt = prompt.call(max_label_length) if prompt.respond_to?(:call)
+      "#{prompt} #{@state.input}"
+    end
+
+    def cursor_position
+      "\e[0;#{max_label_length + @state.input.length + 3 - @state.cursor_offset}H"
+    end
+
+    def rendered_queries
+      @state.results.map.with_index do |result, i|
+        text = [
+          lpad(result.first, max_label_length),
+          rpad(result.last, ANSI.size[:width] - max_label_length - 2)
+        ].join(': ')
+
+        if i == @state.selection
+          text = ANSI.color(text,
+                            fg: Omnibar.config.render.highlight.fg,
+                            bg: Omnibar.config.render.highlight.bg)
+        end
+
+        text
+      end
+    end
+
+    def rpad(text, length = ANSI.size[:width])
+      textlength = text.length + non_ascii_chars(text).length
+      text + (' ' * [0, (length - textlength)].max)
+    end
+
+    def lpad(text, length = ANSI.size[:width])
+      textlength = text.length + non_ascii_chars(text).length
+      (' ' * [0, (length - textlength)].max) + text
+    end
+
+    def max_label_length
+      @mll ||= (@state.results.map(&:first).map(&:length).max || 0) + 1
+    end
+
+    def non_ascii_chars(string)
+      string.chars.select { |c| c.match?(NON_ASCII_REGEX) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnibar
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jacob Evan Shreve
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -123,21 +123,23 @@ files:
 - bin/console
 - bin/setup
 - exe/omnibar
+- lib/ansi.rb
 - lib/omnibar.rb
-- lib/omnibar/ansi.rb
 - lib/omnibar/app.rb
-- lib/omnibar/calculate.rb
-- lib/omnibar/duck_duck_go.rb
-- lib/omnibar/emoji.rb
-- lib/omnibar/github.rb
-- lib/omnibar/google.rb
-- lib/omnibar/popular.rb
+- lib/omnibar/queries/calculate.rb
+- lib/omnibar/queries/duck_duck_go.rb
+- lib/omnibar/queries/emoji.rb
+- lib/omnibar/queries/github.rb
+- lib/omnibar/queries/google.rb
+- lib/omnibar/queries/popular.rb
+- lib/omnibar/queries/snippet.rb
+- lib/omnibar/queries/spell.rb
+- lib/omnibar/queries/system.rb
 - lib/omnibar/query.rb
 - lib/omnibar/renderer.rb
-- lib/omnibar/snippet.rb
-- lib/omnibar/spell.rb
-- lib/omnibar/system.rb
+- lib/omnibar/state.rb
 - lib/omnibar/version.rb
+- lib/omnibar/view.rb
 - omnibar.gemspec
 homepage: https://github.com/shreve/omnibar
 licenses:

data/lib/omnibar/ansi.rb

@@ -1,37 +0,0 @@
-module Omnibar
-  # This module contains helpers for various ansi-code operations
-  module ANSI
-    # ANSI color escape codes set the foreground and background colors.
-    # Forground color is a number between 30 and 37.
-    # Background color is a number between 40 and 47.
-    # The ones place represents the same color for both.
-    COLORS = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, 'white', nil, :white].freeze
-
-    def self.clear_screen
-      $stdout.write "\e[2J"
-    end
-
-    def self.move_cursor(row, col)
-      $stdout.write "\e[#{row + 1};#{col + 1}H"
-    end
-
-    def self.color(text, fg: :white, bg: :black)
-      fg = COLORS.index(fg) + 30
-      bg = COLORS.index(bg) + 40
-      code = "\e[#{[fg, bg].compact.join(';')}m"
-      "#{code}#{text}\e[0m"
-    end
-
-    def self.reset
-      "\e[0m"
-    end
-
-    def self.size
-      win = IO.console.winsize
-      {
-        height: win[0],
-        width: win[1]
-      }
-    end
-  end
-end