search_ui 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42c3eb7c9a29a591cde596b345e5480d25046d01c6f5698199b781d4ca34cf4
-  data.tar.gz: a5533a9c066daae460700dccaec7c129185bee714a4d691703dab40a2b515745
+  metadata.gz: 4bd55ce81380bd3c0eb0d1567dc0b6e5954ca128d8256e77b093d4dca158bf74
+  data.tar.gz: 49975f652e6579eb3a51bb8f11cb1c2ab66cbcb8cc05dc0f6ae7f657cb085f79
 SHA512:
-  metadata.gz: 9b70cd337aabb26826e8780740968c8282909b93952e6cc13bb37ea1c349224aae644ddd89399f5b81238ac52e468692a864ca3d8dc795c5560e102da01e3dbe
-  data.tar.gz: d59cc6ed71ed3a444ceead9380a6355ee3a2171dbf60788152aa0edf5209eeeef6078efba5d9568583ed70733f549b298c41be7402aeec58926c9648f350396b
+  metadata.gz: d88362379d5e903b82d267dd1db8f8062f2f3b675423af826e21945ad935a3e4246c4c1639dfa205f97ea02c7dbab02618e02930af777547014038a221e919df
+  data.tar.gz: c347e48ea327460c68a57092fef8910a91fb1fbaf69a2289e328d1e9d81e7d0791f71efee0a59d82db037bb74952c71acf2c1e2abe63b71f5cf5420029f5a9e5

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/search_ui/search.rb

@@ -1,9 +1,35 @@
 require 'term/ansicolor'
 
+# SearchUI::Search manages interactive console-based searching through an array
+# of objects
+#
+# This class provides an interactive search interface that allows users to
+# filter and select objects from a collection based on text input patterns.
+# It handles terminal input processing, display updates, and user navigation
+# through the search results.
+#
+# @example
+#   SearchUI::Search.new(
+#     match: -> pattern { items.select { |item| item.name.include?(pattern) } },
+#     query: -> answer, matches, selector { matches[selector]&.name || 'No matches' },
+#     found: -> answer, matches, selector { matches[selector] }
+#   ).start
 class SearchUI::Search
   include Term::ANSIColor
   extend Term::ANSIColor
 
+  # Initializes a new SearchUI::Search instance with the specified parameters.
+  #
+  # @param match [ Proc ] a procedure that takes a string and returns an array
+  #   of matching objects
+  # @param query [ Proc ] a procedure that takes the current answer, matches,
+  #   and selector index to generate a query result
+  # @param found [ Proc ] a procedure that takes the current answer, matches,
+  #   jand selector index to determine if a selection has been made
+  # @param output [ IO ] the output stream to display the search interface
+  #   (defaults to STDOUT)
+  # @param prompt [ String ] the prompt template to display during searching
+  #   (defaults to 'Search? %s')
   def initialize(
     match:,
     query:,
@@ -21,6 +47,11 @@ class SearchUI::Search
     @answer       = ''
   end
 
+  # Starts the interactive search interface and handles user input until a
+  # selection is made or the process is cancelled.
+  #
+  # @return [ Object, nil ] returns the selected result object when a selection
+  #   is made, or nil if the process is cancelled
   def start
     @output.print reset
     @matches = @match.(@answer)
@@ -41,13 +72,25 @@ class SearchUI::Search
         return nil
       end
       @matches = @match.(@answer)
-      @selector = [ 0, [ @selector, @matches.size - 1 ].min ].max
+      @selector = @selector.clamp(0, @matches.size - 1)
       result = @query.(@answer, @matches, @selector)
     end
   end
 
   private
 
+  # Reads and processes a single character input from stdin, handling special
+  # key sequences and updating the search state accordingly.
+  #
+  # This method manages raw terminal input to capture user keystrokes,
+  # interpreting control characters and escape sequences for navigation,
+  # selection, and editing operations. It temporarily disables terminal echo
+  # and sets raw mode to ensure proper input handling.
+  #
+  # @return [ Boolean, nil ] returns true when the Enter key is pressed to
+  #   confirm selection, false when Ctrl+C is pressed to cancel the operation, or
+  #   nil for all other inputs
+  #   which update the search state and require further processing
   def getc
     print hide_cursor
     system 'stty raw -echo'
@@ -87,4 +130,3 @@ class SearchUI::Search
     print show_cursor
   end
 end
-

data/lib/search_ui/version.rb

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

data/lib/search_ui.rb

@@ -1,4 +1,15 @@
 
+# SearchUI is a library that provides interactive console-based searching
+# capabilities
+#
+# This module serves as the root namespace for the SearchUI library, which
+# enables users to perform text-based searches through collections of objects
+# directly in the terminal. It offers an intuitive interface for filtering
+# results and selecting items based on user input patterns.
+#
+# The main functionality is provided by the SearchUI::Search class, which
+# handles the interactive search experience including input processing, display
+# management, and result selection.
 module SearchUI
 end
 

data/search_ui.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: search_ui 0.0.5 ruby lib
+# stub: search_ui 0.0.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "search_ui".freeze
-  s.version = "0.0.5".freeze
+  s.version = "0.0.6".freeze
 
   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 = "2024-08-28"
+  s.date = "1980-01-02"
   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]
@@ -18,12 +18,12 @@ Gem::Specification.new do |s|
   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.5.16".freeze
+  s.rubygems_version = "3.6.9".freeze
   s.summary = "Library to provide a user interface for searching in a console".freeze
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.17.0".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.6".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.0".freeze])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0".freeze])

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: search_ui
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +122,6 @@ homepage: https://github.com/flori/search_ui
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - SearchUi -- Search User Interface
@@ -142,8 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Library to provide a user interface for searching in a console
 test_files: []