search_ui 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd55ce81380bd3c0eb0d1567dc0b6e5954ca128d8256e77b093d4dca158bf74
-  data.tar.gz: 49975f652e6579eb3a51bb8f11cb1c2ab66cbcb8cc05dc0f6ae7f657cb085f79
+  metadata.gz: e1bf8a8f5b6d093cff6036196558bfbe4a476be367d1b3af6f724affc6b90db0
+  data.tar.gz: 87813d2915c78f6b7a3f67090264e41ceec84eb0ecf0c80260dd78f22b8c81a3
 SHA512:
-  metadata.gz: d88362379d5e903b82d267dd1db8f8062f2f3b675423af826e21945ad935a3e4246c4c1639dfa205f97ea02c7dbab02618e02930af777547014038a221e919df
-  data.tar.gz: c347e48ea327460c68a57092fef8910a91fb1fbaf69a2289e328d1e9d81e7d0791f71efee0a59d82db037bb74952c71acf2c1e2abe63b71f5cf5420029f5a9e5
+  metadata.gz: 866af2546d78cd716c13e79340a7a1c66ffaa57a4eb379e527adcc77ef3907b00870f0bda7044d96cd4b7dab392b01670d2abe8294eb9376a6bb37302e5fd2bb
+  data.tar.gz: 84e92c9c5815d5b232133d15dedb84e6b69a8577fc49ae2d0b459a5276b09ea32c33ad619d917f546c67ccb049fd954f56282c52ab8a5a4911d649b4b31a1353

data/README.md

@@ -1,20 +1,81 @@
-# SearchUI - Searching things in console
+# 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.
+A Ruby library for creating interactive console-based search interfaces 🎯
 
-## Download
+## Features
 
-The homepage of this library is located at http://github.com/flori/search\_ui
+- **Interactive Navigation** 🎮: Arrow key navigation through search results
+- **Real-time Filtering** ⚡: Instant search updates as you type
+- **Flexible Configuration** 🔧: Customizable matching, display, and selection logic
+- **Terminal-aware** 🖥️: Properly handles terminal input and display management
+- **Minimal Dependencies** 📦: Lightweight implementation using standard Ruby libraries
+
+## Installation
+
+Add this gem to your Gemfile:
+
+```ruby
+gem 'search_ui'
+```
+
+And install it using Bundler:
+
+```bash
+bundle install
+```
+
+Or install the gem directly:
+
+```bash
+gem install search_ui
+```
+
+## Usage
+
+### Library Usage
+
+For programmatic usage, create a custom search interface:
+
+```ruby
+require 'search_ui'
+
+items = ['apple', 'banana', 'cherry', 'date']
+
+result = SearchUI::Search.new(
+  match: ->(pattern) { items.select { |item| item.include?(pattern) } },
+  query: ->(answer, matches, selector) {
+    matches.each_with_index.map do |match, i|
+      if i == selector
+        "→ #{match}"
+      else
+        "  #{match}"
+      end
+    end.join("\n")
+  },
+  found: ->(answer, matches, selector) { matches[selector] }
+).start
+
+puts "Selected: #{result}"
+```
+
+### Command Line Tool
+
+The `search_it` binary provides a ready-to-use search interface:
+
+```bash
+# Search through command-line arguments 🚀
+./bin/search_it apple banana cherry
+
+# Search through a file 📄
+./bin/search_it -f items.txt
+```
 
 ## Author
 
-Florian Frank mailto:flori@ping.de
+[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
+[MIT License](./LICENSE) 📄

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/search_ui/search.rb

@@ -55,7 +55,7 @@ class SearchUI::Search
   def start
     @output.print reset
     @matches = @match.(@answer)
-    @selector = [ 0, [ @selector, @matches.size - 1 ].min ].max
+    @selector = @selector.clamp(0, [ @matches.size - 1, 0 ].max)
     result = @query.(@answer, @matches, @selector)
     loop do
       @output.print clear_screen
@@ -72,7 +72,7 @@ class SearchUI::Search
         return nil
       end
       @matches = @match.(@answer)
-      @selector = @selector.clamp(0, @matches.size - 1)
+      @selector = @selector.clamp(0, [ @matches.size - 1, 0 ].max)
       result = @query.(@answer, @matches, @selector)
     end
   end

data/lib/search_ui/version.rb

@@ -1,6 +1,6 @@
 module SearchUi
   # SearchUi version
-  VERSION         = '0.0.6'
+  VERSION         = '0.0.7'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/search_ui.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: search_ui 0.0.6 ruby lib
+# stub: search_ui 0.0.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "search_ui".freeze
-  s.version = "0.0.6".freeze
+  s.version = "0.0.7".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: search_ui
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Florian Frank