doublespeak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aea84b70ea58db091d8948dbf93a09a1a3905913
+  data.tar.gz: ffe214abadd1fe82486b635f063e0d6c1b6dbac7
+SHA512:
+  metadata.gz: 1b75385fc0931283a6df62b9269673205af8c5000c2e638cdefe09d887cc5fd0a171e5346ef22c81f5ddc58a3cc74816c443382fbc18f89a20352ec1c32992af
+  data.tar.gz: bc1da90c2dbcddf64d8690859219b6f857bf73583eaabdea190fc8c5a412e568b2232183e850727a725afd98f64f69a3120942c192fd9aa3400634cd364fd49e

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    doublespeak (0.1.0)
+      pastel (~> 0.7)
+      tty-reader
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    equatable (0.5.0)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    tty-color (0.4.2)
+    tty-cursor (0.5.0)
+    tty-reader (0.2.0)
+      tty-cursor (~> 0.5.0)
+      tty-screen (~> 0.6.4)
+      wisper (~> 2.0.0)
+    tty-screen (0.6.4)
+    wisper (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.5.0, < 2.0)
+  doublespeak!
+  rake (~> 10.0)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.1

data/Rakefile

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

data/VERSION.txt

@@ -0,0 +1,20 @@
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "predictive_entry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doublespeak.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doublespeak/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doublespeak"
+  spec.version       = Doublespeak::VERSION
+  spec.authors       = ["ccorn90"]
+  spec.email         = [""]
+  spec.summary       = %q{Typeahead entry for Ruby command-line applications}
+  spec.description   = %q{Typeahead entry for Ruby command-line applications}
+  spec.homepage      = "https://github.com/ccorn90/doublespeak"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_runtime_dependency 'tty-reader'
+  spec.add_runtime_dependency 'pastel', '~> 0.7'
+end

data/lib/doublespeak.rb

@@ -0,0 +1,10 @@
+require 'doublespeak/core'
+require 'doublespeak/display'
+require 'doublespeak/string'
+require 'doublespeak/repl'
+
+module Doublespeak
+  def self.new(data_source, options = {})
+    Doublespeak::Repl.new(data_source, options)
+  end
+end

data/lib/doublespeak/core.rb

@@ -0,0 +1,90 @@
+module Doublespeak
+  class Core
+    attr_reader :data_source, :format_data, :display
+    attr_reader :query, :selected_index, :saved_candidates
+
+    def initialize(data_source, options = {})
+      @data_source = data_source
+      @format_data = options[:format_data] || ->(x) { "#{x}" }
+
+      @display = options[:display] || Display.new(options)
+
+      @query = options[:query] || ""
+      @selected_index = options[:selected_index] || 0
+      @saved_candidates = options[:saved_candidates] || []
+    end
+
+    def render
+      display.move_to_origin
+      display.clear_to_end_of_line
+
+      display.write (query + status_line)
+
+      display.move_to_origin
+    end
+
+    def finish_up
+      display.move_to_origin
+      display.clear_to_end_of_line
+      display.set_cursor_visible
+
+      display.write display.format_selected_result.call(format_data.call(candidate)) unless candidate.nil?
+      display.write "\n"
+    end
+
+    def increment_selection(i)
+      @selected_index = selected_index + i
+      if saved_candidates.size == 0
+        @selected_index = 0
+      elsif selected_index < 0
+        @selected_index = saved_candidates.size - 1
+      elsif selected_index >= saved_candidates.size
+        @selected_index = 0
+      end
+    end
+
+    def back_up
+      query.chop!
+    end
+
+    def find_candidates
+      @selected_index = 0
+      @saved_candidates = query.strip.to_s.empty? ? [] : data_source.call(query)
+    end
+
+    def entry(c)
+      if query.length < display.width
+        query.concat(c)
+      end
+    end
+
+    private
+
+    def status_line
+      if saved_candidates.empty?
+        ""
+      else
+        width = display.width - query.length + 1
+        display.format_result.call(candidate_text + selected_index_text).rjust_noescape(width)
+      end
+    end
+
+    def candidate_text
+      max_width = saved_candidates.map { |c| format_data.call(c).length }.max
+
+      format_data.call(candidate)
+        .ljust_noescape(max_width)
+        .format_substring(query, display.format_result_textmatch, downcase: true)
+    end
+
+    def selected_index_text
+      return "" if saved_candidates.length <= 1
+
+      "(#{selected_index+1}/#{saved_candidates.length})".rjust(8, " ")
+    end
+
+    def candidate
+      saved_candidates[selected_index]
+    end
+  end
+end

data/lib/doublespeak/display.rb

@@ -0,0 +1,71 @@
+require 'io/console'
+require 'pastel'
+require 'tty/reader'
+
+module Doublespeak
+  class Display
+    attr_reader :format_result, :format_result_textmatch, :format_selected_result,
+      :origin_col, :origin_row, :screen_width
+
+    def initialize(options)
+      @ostream = options[:ostream] || $stdout
+      @istream = options[:istream] || $stdin
+      @reader = TTY::Reader.new
+
+      colorizer = Pastel::new
+      @format_result = options[:format_result] || colorizer.white.dim.detach
+      @format_result_textmatch = options[:format_result_textmatch] || colorizer.cyan.dim.detach
+      @format_selected_result = options[:format_selected_result] || colorizer.green.dim.detach
+
+      c, r = *cursor_position
+      @origin_col = options[:origin_col] || c
+      @origin_row = options[:origin_row] || r
+      @screen_width = options[:screen_width] || IO.console.winsize[1]
+    end
+
+    def width
+      screen_width - origin_col
+    end
+
+    def move_to_origin
+      write_escaped "[#{origin_row};#{origin_col}H"
+    end
+
+    def clear_to_end_of_line
+      write_escaped "[K"
+    end
+
+    def set_cursor_visible(visible=true)
+      write_escaped(visible ? "[?25h" : "[?25l")
+    end
+
+    def write(str)
+      ostream << str
+    end
+
+    def read
+      reader.read_char
+    end
+
+    private
+
+    attr_reader :ostream, :istream, :reader
+
+    def write_escaped(seq)
+      ostream << "\e#{seq}"
+      ostream.flush
+    end
+
+    def cursor_position
+      res = ''
+      istream.raw do |stream|
+        write_escaped("[6n")
+        while (c = stream.getc) != 'R'
+          res << c if c
+        end
+      end
+      m = res.match(/(?<row>\d+);(?<column>\d+)/)
+      [Integer(m[:column]), Integer(m[:row])]
+    end
+  end
+end

data/lib/doublespeak/repl.rb

@@ -0,0 +1,43 @@
+module Doublespeak
+  class Repl
+    def initialize(data_source, options = {})
+      raise ArgumentError.new("Must provide a data_source") if data_source.nil?
+      @core = Core.new(data_source, options)
+    end
+
+    def run
+      continue = true
+
+      while continue
+        core.render
+        core.display.set_cursor_visible(core.query.empty?)
+
+        char = core.display.read
+        case char
+        when "\r"
+          if core.saved_candidates.present?
+            continue = false
+            core.finish_up
+          end
+
+        when "\e[A"
+          core.increment_selection(-1)
+
+        when "\e[B"
+          core.increment_selection(+1)
+
+        when "\u007F"
+          core.back_up
+          core.find_candidates
+
+        when /^[a-zA-Z0-9 ]/
+          core.entry(char)
+          core.find_candidates
+        end
+      end
+    end
+
+    private
+    attr_reader :core
+  end
+end

data/lib/doublespeak/string.rb

@@ -0,0 +1,24 @@
+class String
+  def noescape
+    gsub(%r{\e[^m]*m}, '')
+  end
+
+  def ljust_noescape(width, delim=" ")
+    self + delim*(width - noescape.length)
+  end
+
+  def rjust_noescape(width, delim=" ")
+    delim*(width - noescape.length) + self
+  end
+
+  def format_substring(substring, formatter, downcase: false)
+    index = downcase ? self.downcase.index(substring.downcase) : index(substring)
+
+    if index.nil?
+      self
+    else
+      substring = self[index, substring.length]
+      gsub(substring, formatter.call(substring))
+    end
+  end
+end

data/lib/doublespeak/version.rb

@@ -0,0 +1,3 @@
+module Doublespeak
+  VERSION="0.1.0"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: doublespeak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ccorn90
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: tty-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Typeahead entry for Ruby command-line applications
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION.txt
+- bin/console
+- bin/setup
+- doublespeak.gemspec
+- lib/doublespeak.rb
+- lib/doublespeak/core.rb
+- lib/doublespeak/display.rb
+- lib/doublespeak/repl.rb
+- lib/doublespeak/string.rb
+- lib/doublespeak/version.rb
+- tmp/.keep
+homepage: https://github.com/ccorn90/doublespeak
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Typeahead entry for Ruby command-line applications
+test_files: []