search_ui 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37d829ad8fbcc4b4e0ae9e986f10b156edea28650062f1e53d79c767fe07dbc1
+  data.tar.gz: 851f87e4e5731d1b515a6354cc13a95820007d179acdee7621009b318378a501
+SHA512:
+  metadata.gz: 1beb2eb6a53971c40ab62c898ef5c78fe9c59a39e5b8fa4bd61dedf2c9271b94ad8379fdbbb54a2f50a359e979e9cccc43e0585ebdb8a2103a782685e3fcc0a8
+  data.tar.gz: 0270c1ec8d11b71335ea880c3fc82c4b919f21b97d0e76267cb3f8766a459f130c57a73344e1697644555761145957b78e6e23b83b23a8977e8f7e87031953be

data/.gitignore

@@ -0,0 +1,9 @@
+.*.sw[pon]
+.AppleDouble
+.DS_Store
+.byebug_history
+.rvmrc
+Gemfile.lock
+coverage
+pkg
+tags

data/Gemfile

@@ -0,0 +1,5 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2020 Florian Frank
+
+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 X
+CONSORTIUM 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,20 @@
+# SearchUI - Searching things in console
+
+## Description
+
+This library allows a user to search an array of objects
+interactively in the console by matching the pattern a user inputs to an
+array of objects and pick one of the remaining objects.
+
+## Download
+
+The homepage of this library is located at http://github.com/flori/search\_ui
+
+## Author
+
+Florian Frank mailto:flori@ping.de
+
+## License
+
+This software is licensed under the X11 (or MIT) license:
+http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3

data/Rakefile

@@ -0,0 +1,28 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+require 'gem_hadar'
+
+GemHadar do
+  name        'search_ui'
+  author      'Florian Frank'
+  email       'flori@ping.de'
+  homepage    "http://flori.github.com/#{name}"
+  summary     'Library to provide a user interface for searching in a console'
+  description 'This library allows a user to search an array of objects
+  interactively in the console by matching the pattern a user inputs to an
+  array of objects and pick one of the remaining objects.'
+
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
+    '.AppleDouble', 'tags', '.byebug_history', '.DS_Store'
+  readme      'README.md'
+  title       "#{name.camelize} -- Search User Interface"
+
+  executables << 'search_it'
+
+  required_ruby_version '>= 2.0'
+  dependency  'tins', '~>1.0'
+  dependency 'term-ansicolor', '~>1.0'
+  dependency 'amatch', '~>0.0'
+  development_dependency 'simplecov', '~>0.0'
+  licenses << 'MIT'
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/search_it

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'search_ui'
+require 'tins/terminal'
+require 'amatch'
+include SearchUI
+
+
+choices = ARGV
+exit if choices.empty?
+
+found = Search.new(
+  match: -> answer {
+    matcher = Amatch::PairDistance.new(answer.downcase)
+    matches = ARGV.map { |n| [ n, -matcher.similar(n.downcase) ] }.
+      select { |_, s| s < 0 }.sort_by(&:last).map(&:first)
+    matches.empty? and matches = choices
+    matches.first(Tins::Terminal.lines - 1)
+  },
+  query: -> _answer, matches, selector {
+    matches.each_with_index.
+    map { |m, i| i == selector ? "→ " + Search.on_blue(m) : "  " + m } * ?\n
+  },
+  found: -> _answer, matches, selector {
+    matches[selector]
+  },
+  output: STDOUT
+).start and puts found

data/lib/search_ui.rb

@@ -0,0 +1,6 @@
+
+module SearchUI
+end
+
+require 'search_ui/version'
+require 'search_ui/search'

data/lib/search_ui/search.rb

@@ -0,0 +1,90 @@
+require 'term/ansicolor'
+
+class SearchUI::Search
+  include Term::ANSIColor
+  extend Term::ANSIColor
+
+  def initialize(
+    match:,
+    query:,
+    found:,
+    output: STDOUT,
+    prompt: 'Search? %s'
+  )
+    @match        = match
+    @query        = query
+    @found        = found
+    @output       = output
+    @prompt       = prompt
+    @selector     = 0
+    @max_selector = nil
+    @answer       = ''
+  end
+
+  def start
+    @output.print reset
+    @matches = @match.(@answer)
+    @selector = [ 0, [ @selector, @matches.size - 1 ].min ].max
+    result = @query.(@answer, @matches, @selector)
+    @output.print clear_screen
+    @output.print move_home { ?\n + result }
+    loop do
+      @output.print move_home { @prompt % @answer }
+      case getc
+      when true
+        @output.print clear_screen, move_home, reset
+        if result = @found.(@answer, @matches, @selector)
+          return result
+        else
+          return nil
+        end
+      when false
+        return nil
+      end
+      @matches = @match.(@answer)
+      @selector = [ 0, [ @selector, @matches.size - 1 ].min ].max
+      result = @query.(@answer, @matches, @selector)
+      @output.print clear_screen
+      @output.print move_home { ?\n + result }
+    end
+  end
+
+  private
+
+  def getc
+    system 'stty raw -echo'
+    c = STDIN.getc
+    system 'stty cooked echo'
+    case c
+    when "\x03"
+      false
+    when "\e"
+      STDIN.getc == ?[ or return nil
+      STDIN.getc =~ /\A([AB])\z/ or return nil
+      if $1 == ?A
+        @selector -= 1
+      else
+        @selector += 1
+      end
+      @selector = [ @selector, 0 ].max
+      nil
+    when ?\r
+      true
+    when "\x7f"
+      @selector = 0
+      @answer.chop!
+      nil
+    when "\v"
+      @selector = 0
+      @answer.clear
+      nil
+    when /\A[\x00-\x1f]\z/
+      nil
+    else
+      @selector = 0
+      @answer << c
+      nil
+    end
+  end
+end
+

data/lib/search_ui/version.rb

@@ -0,0 +1,8 @@
+module SearchUi
+  # SearchUi version
+  VERSION         = '0.0.0'
+  VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end

data/search_ui.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+# stub: search_ui 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "search_ui".freeze
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Florian Frank".freeze]
+  s.date = "2020-02-11"
+  s.description = "This library allows a user to search an array of objects\n  interactively in the console by matching the pattern a user inputs to an\n  array of objects and pick one of the remaining objects.".freeze
+  s.email = "flori@ping.de".freeze
+  s.executables = ["search_it".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/search_ui.rb".freeze, "lib/search_ui/search.rb".freeze, "lib/search_ui/version.rb".freeze]
+  s.files = [".gitignore".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/search_it".freeze, "lib/search_ui.rb".freeze, "lib/search_ui/search.rb".freeze, "lib/search_ui/version.rb".freeze, "search_ui.gemspec".freeze]
+  s.homepage = "http://flori.github.com/search_ui".freeze
+  s.licenses = ["MIT".freeze]
+  s.rdoc_options = ["--title".freeze, "SearchUi -- Search User Interface".freeze, "--main".freeze, "README.md".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.0".freeze)
+  s.rubygems_version = "3.1.2".freeze
+  s.summary = "Library to provide a user interface for searching in a console".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.11.0"])
+    s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.0"])
+    s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0"])
+    s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.0"])
+    s.add_runtime_dependency(%q<amatch>.freeze, ["~> 0.0"])
+  else
+    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.11.0"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.0"])
+    s.add_dependency(%q<tins>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<amatch>.freeze, ["~> 0.0"])
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: search_ui
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Florian Frank
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_hadar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: amatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: |-
+  This library allows a user to search an array of objects
+    interactively in the console by matching the pattern a user inputs to an
+    array of objects and pick one of the remaining objects.
+email: flori@ping.de
+executables:
+- search_it
+extensions: []
+extra_rdoc_files:
+- README.md
+- lib/search_ui.rb
+- lib/search_ui/search.rb
+- lib/search_ui/version.rb
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/search_it
+- lib/search_ui.rb
+- lib/search_ui/search.rb
+- lib/search_ui/version.rb
+- search_ui.gemspec
+homepage: http://flori.github.com/search_ui
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- SearchUi -- Search User Interface
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Library to provide a user interface for searching in a console
+test_files: []