yap-shell-addon-history-search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dada9ffa8c190994aacc85d42c19d2dd5387029
+  data.tar.gz: 7e2e88558230a01ff42c4fe4ec92b4a4f401c2f2
+SHA512:
+  metadata.gz: a18877352da26122f1011dd3f709f4d81eb23f6e387378f8a780027740208a868f71f43d89875a20733ac40814253c4ce6d70b0f4920183d3e8a6543a55458fa
+  data.tar.gz: 456be63f837eb0da266b8f3dc4118b460a36764067d03b9fc24e2ec71a5e41be2122bc48e58be7c84fd63cf7bab8cc907af4ad44d108f7c8865f25142f441e5b

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+wiki/

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yap-shell-addon-history-search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zach Dennis
+
+
+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,40 @@
+# history-search for yap-shell
+
+Welcome to your new yap addon! In this directory, you'll find the files you need to be able to package up your addon into a gem. Put your Ruby code in the file `lib/yap-shell-addon-history-search`.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yap-shell-addon-history-search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yap-shell-addon-history-search
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yap-shell-addon-history-search.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "yap/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/yap-shell-addon-history-search.rb

@@ -0,0 +1,205 @@
+require 'yap/addon'
+require 'yap-shell-addon-history-search/version'
+
+module YapShellAddonHistorySearch
+  class Addon < ::Yap::Addon::Base
+    self.export_as :'history-search'
+
+    attr_reader :editor
+
+    def initialize_world(world)
+      @editor = world.editor
+    end
+
+    def prompt_user_to_search
+      label_text = "(reverse-search): "
+      search_label = ::TerminalLayout::Box.new(
+        content: label_text,
+        style: {
+          display: :inline,
+          height: 1
+        }
+      )
+      search_box = ::TerminalLayout::InputBox.new(
+        content: "",
+        style: {
+          display: :inline,
+          height: 1
+        }
+      )
+      search_box.name = "focused-input-box"
+
+      Treefell['shell'].puts "editor.content_box.children: #{editor.content_box.children.inspect}"
+      history_search_env = editor.new_env
+      history_search = Search.new(editor.history,
+        line: ::RawLine::LineEditor.new(::RawLine::Line.new, sync_with: -> { search_box }),
+        keys: history_search_env.keys,
+        search: -> (term:, result:){
+          # when there is no match, result will be nil, #to_s clears out the content
+          editor.input_box.content = result.to_s
+        },
+        done: -> (execute:, result:){
+          editor.content_box.children = []
+          editor.pop_env
+          editor.focus_input_box(editor.input_box)
+          editor.overwrite_line(result.to_s)
+          editor.process_line if execute
+        }
+      )
+
+      editor.push_env history_search_env
+      editor.push_keyboard_input_processor(history_search)
+
+      editor.content_box.children = [search_label, search_box]
+      editor.focus_input_box(search_box)
+    end
+
+    class Search
+      attr_reader :keys
+
+      def initialize(history, keys:, line:, search:, done:)
+        @history = history
+        @keys = keys
+        @line = line
+        @search_proc = search || -> {}
+        @done_proc = done || -> {}
+
+        initialize_key_bindings
+      end
+
+      def initialize_key_bindings
+        @keys.bind(:return){ execute }
+        @keys.bind(:ctrl_j){ accept }
+        @keys.bind(:ctrl_r){ search_again_backward }
+        @keys.bind(:ctrl_n){ search_again_forward }
+        @keys.bind(:ctrl_a){ @line.move_to_beginning_of_input }
+        @keys.bind(:ctrl_e){ @line.move_to_end_of_input }
+        @keys.bind(:ctrl_k){ @line.kill_forward }
+        @keys.bind(:backspace) do
+          @line.delete_left_character
+          perform_search(type: @last_search_was)
+        end
+        @keys.bind(:escape){ cancel }
+        @keys.bind(:ctrl_c){ cancel }
+      end
+
+      def read_bytes(bytes)
+        if bytes.any?
+          Treefell['shell'].puts "history search found bytes: #{bytes.inspect}"
+
+          search_bytes = process_bytes(bytes)
+
+          if search_bytes.any?
+            Treefell['shell'].puts "history searching with bytes=#{bytes.inspect}"
+            search_with_bytes(bytes)
+          end
+        end
+      end
+
+      private
+
+      # given [1,2,3] first try [1,2,3]. If no key binding
+      # matches, then try [1,2]. If no keybinding matches try [1].
+      # Execution should flow in left to right, positional order.
+      # This returns an array of left over bytes in the order they
+      # appeared that did not match any keybinding
+      def process_bytes bytes, leftover=[]
+        if bytes.empty?
+          leftover
+        elsif @keys[bytes]
+          @keys[bytes].call
+          leftover
+        else
+          process_bytes(
+            bytes[0..-2],
+            [bytes[-1]].concat(leftover)
+          )
+        end
+      end
+
+      def accept
+        @done_proc.call(execute: false, result: result)
+      end
+
+      def cancel
+        @done_proc.call(execute: false, result: nil)
+      end
+
+      def execute
+        @done_proc.call(execute: true, result: result)
+      end
+
+      def found_match(result:)
+        @search_proc.call(term: @line.text, result: result)
+      end
+
+      def no_match_found
+        @last_match_index = nil
+        @search_proc.call(term: @line.text, result: result)
+      end
+
+      def result
+        @history2search[@last_match_index] if @last_match_index
+      end
+
+      def search_again_backward
+        Treefell['shell'].puts "history searching again backward"
+        if @last_search_was == :forward
+          @last_match_index = @history.length - @last_match_index - 1
+          @history2search = @history.reverse
+        end
+        perform_search(starting_index: @last_match_index, type: :backward)
+      end
+
+      def search_again_forward
+        Treefell['shell'].puts "history searching again forward"
+        if @last_search_was == :backward
+          @last_match_index = @history.length - @last_match_index - 1
+          @history2search = @history
+        end
+        perform_search(starting_index: @last_match_index, type: :forward)
+      end
+
+      def search_with_bytes(bytes)
+        part = bytes.map(&:chr).join
+        @line.write(part.scan(/[[:print:]]/).join)
+        @history2search = @history.reverse
+        perform_search(type: :backward)
+      end
+
+      def perform_search(starting_index: -1, type:)
+        if @line.text.empty?
+          no_match_found
+          return
+        end
+
+        # fuzzy search
+        characters = @line.text.split('').map { |ch| Regexp.escape(ch) }
+        fuzzy_search_regex = /#{characters.join('.*?')}/
+
+        # non-fuzzy-search
+        # fuzzy_search_regex = /#{Regexp.escape(@line.text)}/
+
+        Treefell['shell'].puts "history search matching on regex=#{fuzzy_search_regex.inspect} starting_index=#{starting_index}"
+        @last_search_was = type
+
+        match = @history2search.detect.with_index do |item, i|
+          next if i <= starting_index
+
+          # Treefell['shell'].puts "history search matching #{(item + @line.text).inspect} =~ #{fuzzy_search_regex}"
+          md = (item + @line.text).match(fuzzy_search_regex)
+          if md && md.end(0) <= item.length
+            # Treefell['shell'].puts "history search match #{item} at #{i}"
+            @last_match_index = i
+          end
+        end
+
+        if match
+          found_match(result: match)
+        else
+          no_match_found
+        end
+      end
+    end
+  end
+end

data/lib/yap-shell-addon-history-search/version.rb

@@ -0,0 +1,3 @@
+module YapShellAddonHistorySearch
+  VERSION = '0.1.0'
+end

data/yap-shell-addon-history-search.gemspec

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/lib/yap-shell-addon-history-search/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'yap-shell-addon-history-search'
+  spec.version = YapShellAddonHistorySearch::VERSION
+  spec.authors  = ['Your name']
+  spec.email    = 'you@example.com'
+  spec.date    = Date.today.to_s
+
+  spec.summary = 'history-search summary goes here.'
+  spec.description = 'history-search description goes here.'
+  spec.homepage = ''
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yap-shell", "~> 0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: yap-shell-addon-history-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Your name
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yap-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: history-search description goes here.
+email: you@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yap-shell-addon-history-search.rb
+- lib/yap-shell-addon-history-search/version.rb
+- yap-shell-addon-history-search.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: history-search summary goes here.
+test_files: []
+has_rdoc: