fancy_gets 0.1.5 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77bf7ba22ad95c65d42649eb16261214fb9ae5eb
-  data.tar.gz: 00e074cd4911c829b20128c3da56ff5f48c1e9ab
+SHA256:
+  metadata.gz: 51c96b67bf9c4b86e5a928042a1ef0923d720cedc3e75dc659bd58910c284e8c
+  data.tar.gz: 222b64256299e56e23c0829b2fb7a855d6d4f38cd158926040d661deb0121583
 SHA512:
-  metadata.gz: dc71e4648a88261ecbeaa3239e3bef66c91d1e85a80d7645b5db6a8b6fb72cd24c35723f6143a7cb638c3fbc351d68942ca1c1031b1211013180c4cda290c6b5
-  data.tar.gz: 68b1d41ee9817c6784022595a0299562d92b57984f3320c9d5ed91df7013829d06613b2634a1ab04659aee592b3d052650ebd599cd323e9d333248ad816274e0
+  metadata.gz: 573430996f606e869215ceb26ed019753192d9344d5c182027e22a9b9b09167eedc8938d994a0cdfbc64f8e3f6f1c9d4c57ff6eb1dc50d216632270c79ad78da
+  data.tar.gz: ece58b484fcf7fbf88c16f94d00a3868743c9218f5b0069cb9eaf12fb29d252aa0259945e3e8cf61641053a033829918d99be835a0c499336e73887dc5fd038e

data/README.md

@@ -75,6 +75,26 @@ picked_toys = gets_list(toys, true, ["Kite", "Water Gun"])
 puts "\nYou've picked #{picked_toys.join(", ")}."
 ```
 
+You can also pass in parameters as a hash, which brings even more possibility because you can pass in callbacks!  Here's how to dynamically update the info line at the bottom to indicate how many things have been chosen so far:
+
+```ruby
+picked_toys = gets_list(
+  list: toys,
+  is_multiple: true,
+  chosen: [],
+  prefix: "\033[1;32m>\033[1;35m> \033[0m",
+  postfix: "\033[1;35m <\033[1;32m<\033[0m",
+  height: 4,
+  on_change: proc{ |data|
+    "You have chosen #{data[:chosen].count} items"
+  }
+)
+puts "\nAren't callbacks cool?"
+```
+
+You can also set a callback for on_select, which responds when people are arrowing around through the list.  With the blocks in both on_change and on_select if a string is returned, it will update what is shown in the info line at the bottom.
+
+
 ## gets_auto_suggest
 
 Still using the same cool array of things, let's have the user see auto-suggest text

data/fancy_gets.gemspec

@@ -35,6 +35,6 @@ It's all here.  Enjoy!}
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/fancy_gets.rb

@@ -1,4 +1,4 @@
-require "fancy_gets/version"
+require_relative "fancy_gets/version"
 require 'io/console'
 
 module FancyGets
@@ -26,7 +26,7 @@ module FancyGets
       words = words[:list]
     else
       # Trying to supply parameters but left out a "true" for is_multiple?
-      if is_multiple.is_a?(Enumerable) || is_multiple.is_a?(String) || is_multiple.is_a?(Fixnum)
+      if is_multiple.is_a?(Enumerable) || is_multiple.is_a?(String) || is_multiple.is_a?(Numeric)
         chosen = is_multiple
         is_multiple = false
       end
@@ -40,10 +40,10 @@ module FancyGets
   def self.gets_internal_core(is_list, is_password, word_objects = nil, chosen = nil, prefix = "> ", postfix = " <", info = nil, height = nil, on_change = nil, on_select = nil)
     # OK -- second parameter, is_password, means is_multiple when is_list is true
     is_multiple = is_list & is_password
-    unless word_objects.nil? || is_list
+    if word_objects && !is_list
       word_objects.sort! {|wo1, wo2| wo1.to_s <=> wo2.to_s}
     end
-    words = word_objects.map(&:to_s)
+    words = word_objects&.map(&:to_s) || []
     if is_multiple
       chosen ||= [0] unless is_multiple
     else
@@ -55,10 +55,12 @@ module FancyGets
       end
     end
     position = 0
-    height = words.length unless !height.nil? && height.is_a?(Numeric) && height > 2
-    winheight = IO.console.winsize.first - 3
+    # Up and down arrows break with height of 3 or less
+    height = words.length unless height&.is_a?(Numeric) && height >= 4
+    winheight = (IO.console || STDOUT).winsize.first - 3
+    height = words.length if height > words.length
     height = winheight if height > winheight
-    offset = (height < words.length) ? 0 : nil
+    offset = 0
     sugg = ""
     prev_sugg = ""
 
@@ -79,12 +81,14 @@ module FancyGets
       " - #{sugg}#{" " * extra_spaces} #{"\b" * ((uncolor.call(sugg).length + 4 + extra_spaces) + string.length - position)}"
     end
 
-    pre_post_length = uncolor.call(prefix + postfix).length
+    pre_length = uncolor.call(prefix).length
+    post_length = uncolor.call(postfix).length
+    pre_post_length = pre_length + post_length
 
     # Used for dropdown select / deselect
     clear_dropdown_info = lambda do
       print "\b" * (uncolor.call(words[position]).length + pre_post_length)
-      print (27.chr + 91.chr + 66.chr) * (height - (position - (offset || 0)) - (height < words.length ? 1 : 0))
+      print (27.chr + 91.chr + 66.chr) * ((height + offset) - position)
       info_length = uncolor.call(info).length
       print " " * info_length + "\b" * info_length
     end
@@ -94,7 +98,7 @@ module FancyGets
       if is_select
         print "#{prefix}#{word}#{postfix}"
       else
-        print "#{" " * uncolor.call(prefix).length}#{word}#{" " * uncolor.call(postfix).length}"
+        print "#{" " * pre_length}#{word}#{" " * post_length}"
       end
       print " " * (max_word_length - uncolor.call(words[position]).length)
       print "\b" * (max_word_length - uncolor.call(words[position]).length)
@@ -105,11 +109,12 @@ module FancyGets
       # Put the response into the info line, as long as it's short enough!
       new_info.gsub!("\n", " ")
       new_info_length = uncolor.call(new_info).length
-      console_width = IO.console.winsize.last
+      console_width = (IO.console || STDOUT).winsize.last
       # Might have to trim if it's a little too wide
       new_info = new_info[0...console_width] if console_width < new_info_length
       # Arrow down to the info line
-      print (27.chr + 91.chr + 66.chr) * (height - (position - (offset || 0)) - (height < words.length ? 1 : 0))
+      distance_down = (height + offset) - position
+      print (27.chr + 91.chr + 66.chr) * distance_down
       # To start of info line
       word_length = uncolor.call(words[position]).length + pre_post_length
       print "\b" * word_length
@@ -120,15 +125,15 @@ module FancyGets
       print new_info + " " * difference
       info = new_info
       # Go up to where we originated
-      print (27.chr + 91.chr + 65.chr) * (height - (position - (offset || 0)) - (height < words.length ? 1 : 0))
+      print (27.chr + 91.chr + 65.chr) * distance_down
       # Arrow left or right to get to the right spot again
       new_info_length += difference
       print (new_info_length > word_length ? "\b" : (27.chr + 91.chr + 67.chr)) * (new_info_length - word_length).abs
     end
 
-    handle_on_select = lambda do |focused|
+    handle_on_select = lambda do |selected|
       if on_select.is_a? Proc
-        response = on_select.call({chosen: chosen, focused: focused})
+        response = on_select.call({chosen: chosen, selected: selected})
         new_info = nil
         if response.is_a? Hash
           chosen = response[:chosen] || chosen
@@ -136,25 +141,30 @@ module FancyGets
         elsif response.is_a? String
           new_info = response
         end
-        unless new_info.nil?
-          write_info.call(new_info)
-        end
+        write_info.call(new_info) if new_info
       end
     end
 
+    # **********************************************
+    # ******************** DOWN ********************
+    # Doesn't work with a height of 3 when there's more than 3 in the list
     arrow_down = lambda do
       if position < words.length - 1
-        handle_on_select.call(word_objects[position + 1])
         is_shift = false
+        handle_on_select.call(word_objects[position + 1])
         # Now moving down past the bottom of the shown window?
-        if !offset.nil? && position >= offset + (height - 3)
+        is_before_end = height + offset < words.length
+        if is_before_end && position == (height - 2) + offset
           print "\b" * (uncolor.call(words[position]).length + pre_post_length)
-          print (27.chr + 91.chr + 65.chr) * (height - (offset > 0 ? 3 : 3))
+          print (27.chr + 91.chr + 65.chr) * (height - 3)
+          if offset == 0
+            print (27.chr + 91.chr + 65.chr)
+            puts "#{" " * pre_length}#{"↑" * max_word_length}#{" " * post_length}"
+          end
           offset += 1
-          # Add 1 if offset + height == (words.length - 1)
-          (offset...(offset + height - 4)).each do |i|
+          ((offset + 1)..(offset + (height - 4))).each do |i|
             end_fill = max_word_length - uncolor.call(words[i]).length
-            puts (is_multiple && chosen.include?(i)) ? "#{prefix}#{words[i]}#{postfix}#{" " * end_fill}" : "#{" " * uncolor.call(prefix).length}#{words[i]}#{" " * (end_fill + uncolor.call(postfix).length)}"
+            puts (is_multiple && chosen.include?(i)) ? "#{prefix}#{words[i]}#{postfix}#{" " * end_fill}" : "#{" " * pre_length}#{words[i]}#{" " * (end_fill + post_length)}"
           end
           is_shift = true
         end
@@ -163,6 +173,13 @@ module FancyGets
         position += 1
         print 27.chr + 91.chr + 66.chr
         if is_shift || !is_multiple
+          if is_shift && height + offset == words.length  # Go down and write the last one
+            print 27.chr + 91.chr + 66.chr
+            position += 1
+            make_select.call(is_shift && chosen.include?(position), false, true)
+            print 27.chr + 91.chr + 65.chr  # And back up
+            position -= 1
+          end
           make_select.call((chosen.include?(position) && is_shift) || !is_multiple)
         else
           w2 = uncolor.call(words[position]).length
@@ -171,28 +188,42 @@ module FancyGets
       end
     end
 
+    # **********************************************
+    # ********************** UP ********************
     arrow_up = lambda do
       if position > 0
-        handle_on_select.call(word_objects[position - 1])
         is_shift = false
+        handle_on_select.call(word_objects[position - 1])
         # Now moving up past the top of the shown window?
-        if position <= (offset || 0)
+        if position > 1 && position <= offset + 1 # - (offset > 1 ? 0 : -1)
           print "\b" * (uncolor.call(words[position]).length + pre_post_length)
           offset -= 1
-          # print (27.chr + 91.chr + 65.chr) if offset == 0
-          (offset...(offset + height - 2)).each do |i|
+          # Up next to the top, and write the first word over the up arrows
+          if offset == 0
+            print (27.chr + 91.chr + 65.chr)
+            end_fill = max_word_length - uncolor.call(words[0]).length
+            puts (is_multiple && chosen.include?(0)) ? "#{prefix}#{words[0]}#{postfix}#{" " * end_fill}" : "#{" " * pre_length}#{words[0]}#{" " * (end_fill + post_length)}"
+          end
+          ((offset + 1)..(offset + height - 2)).each do |i|
             end_fill = max_word_length - uncolor.call(words[i]).length
-            puts (is_multiple && chosen.include?(i)) ? "#{prefix}#{words[i]}#{postfix}#{" " * end_fill}" : "#{" " * uncolor.call(prefix).length}#{words[i]}#{" " * (end_fill + uncolor.call(postfix).length)}"
+            puts ((!is_multiple && i == (offset + 1)) || (is_multiple && chosen.include?(i))) ? "#{prefix}#{words[i]}#{postfix}#{" " * end_fill}" : "#{" " * pre_length}#{words[i]}#{" " * (end_fill + post_length)}"
           end
-          print (27.chr + 91.chr + 65.chr) * (height - (offset > 0 ? 3 : 3))
+          if offset == words.length - height - 1
+            puts "#{" " * pre_length}#{"↓" * max_word_length}#{" " * post_length}"
+            print (27.chr + 91.chr + 65.chr)
+          end
+          print (27.chr + 91.chr + 65.chr) * (height - 2)
           is_shift = true
+          position -= 1
+          w1 = -pre_post_length
+        else
+          make_select.call(chosen.include?(position) && is_shift && is_multiple, true, true) if is_shift || !is_multiple
+          w1 = uncolor.call(words[position]).length
+          position -= 1
+          print 27.chr + 91.chr + 65.chr
         end
-        make_select.call(chosen.include?(position) && is_shift && is_multiple, true, true) if is_shift || !is_multiple
-        w1 = uncolor.call(words[position]).length
-        position -= 1
-        print 27.chr + 91.chr + 65.chr
-        if is_shift || !is_multiple
-          make_select.call((chosen.include?(position) && is_shift) || !is_multiple)
+        if !is_shift && !is_multiple
+          make_select.call(chosen.include?(position) || !is_multiple)
         else
           w2 = uncolor.call(words[position]).length
           print (w1 > w2 ? "\b" : (27.chr + 91.chr + 67.chr)) * (w1 - w2).abs
@@ -200,29 +231,30 @@ module FancyGets
       end
     end
 
+    # Initialize everything
     if is_list
       # Maybe confirm the height is adequate by checking out IO.console.winsize
-      case chosen.class.name
-      when "Fixnum"
+      case
+      when chosen.is_a?(Numeric)
         chosen = [chosen]
-      when "String"
+      when chosen.is_a?(String)
         if words.include?(chosen)
           chosen = [words.index(chosen)]
         else
           chosen = []
         end
-      when "Array"
+      when chosen.is_a?(Array)
         chosen.each_with_index do |item, i|
-          case item.class.name
-          when "String"
+          case
+          when item.is_a?(String)
             chosen[i] = words.index(item)
-          when "Fixnum"
+          when item.is_a?(Numeric)
             chosen[i] = nil if item < 0 || item >= words.length
           else
             chosen[i] = word_objects.index(item)
           end
         end
-        chosen.select{|item| !item.nil?}.uniq
+        chosen.compact.uniq
       else
         if word_objects.include?(chosen)
           chosen = [word_objects.index(chosen)]
@@ -234,28 +266,30 @@ module FancyGets
       chosen = [0] if chosen == [] && !is_multiple
       position = chosen.first if chosen.length > 0
       # If there's more options than we can fit at once
-      unless offset.nil?
+      if height < words.length
         # ... put the chosen one a third of the way down the screen
         offset = position - (height / 3)
+        offset = words.length - height if offset > words.length - height
         offset = 0 if offset < 0
       end
+
+      # **********************************************
+      # **********************************************
+      # **********************************************
+      # **********************************************
+      # **********************************************
+
       # Scrolled any amount downwards?
-      #   was: if (offset || 0) > 0
-      puts "#{" " * uncolor.call(prefix).length}#{"↑" * max_word_length}" if height < words.length
-      #   was: ((offset || 0) > 1 ? 2 : 1)
-      top_bottom_reserved = offset.nil? ? 0 : 2
-      last_word = (offset || 0) + height - top_bottom_reserved
-      # Maybe we can fit it all
-      last_word = words.length if last_word > words.length
+      #   was: if height < words.length
+      puts "#{" " * pre_length}#{"↑" * max_word_length}" if offset > 0
+      last_word = (height - 2) + offset + (height + offset < words.length ? 0 : 1)
       # Write all the visible words
-      ((offset || 0)...last_word).each { |i| puts chosen.include?(i) ? "#{prefix}#{words[i]}#{postfix}" : "#{" " * uncolor.call(prefix).length}#{words[i]}" }
+      ((offset + (offset > 0 ? 1 : 0))..last_word).each { |i| puts chosen.include?(i) ? "#{prefix}#{words[i]}#{postfix}" : "#{" " * pre_length}#{words[i]}" }
       # Can't fit it all?
-      #   was: if last_word < (words.length - top_bottom_reserved)
-      puts "#{" " * uncolor.call(prefix).length}#{"↓" * max_word_length}" if height < words.length
+      puts "#{" " * pre_length}#{"↓" * max_word_length}" if height + offset < words.length
 
       info ||= "Use arrow keys#{is_multiple ? ", spacebar to toggle, and ENTER to save" : " and ENTER to make a choice"}"
-      # %%% used to be (words.length - position), and then (last_word <= words.length)
-      print info + (27.chr + 91.chr + 65.chr) * (height - (position - (offset || 0)) - (height < words.length ? 1 : 0))
+      print info + (27.chr + 91.chr + 65.chr) * ((last_word - position) + (height + offset < words.length ? 2 : 1))
       # To end of text on starting line
       info_length = uncolor.call(info).length
       word_length = uncolor.call(words[position]).length + pre_post_length
@@ -274,6 +308,7 @@ module FancyGets
       case code
       when 3 # CTRL-C
         clear_dropdown_info.call if is_list
+        # puts "o: #{offset} p: #{position} h: #{height} wl: #{words.length}"
         exit
       when 13 # ENTER
         if is_list
@@ -316,14 +351,21 @@ module FancyGets
               position += 1
             end
           when 66 # - down
-            if is_list
-              arrow_down.call
-            end
+            arrow_down.call if is_list
           when 65 # - up
-            if is_list
-              arrow_up.call
+            arrow_up.call if is_list
+          when 51 # - Start of a possible delete forwards?
+            if STDIN.getch.ord == 126 # - Delete (forwards)
+              if !is_list && position < string.length
+                string = string[0...position] + string[position + 1..-1]
+                if words.empty?
+                  print "#{is_password ? "*" * (string.length - position) : string[position..-1]} #{"\b" * (string.length - position + 1)}"
+                else
+                  prev_sugg = sugg
+                  print "#{string[position..-1]}#{write_sugg.call}"
+                end
+              end
             end
-          when 51 # - Delete forwards?
           else
             # puts "ESC 91 #{ch}"
           end
@@ -334,7 +376,7 @@ module FancyGets
       when 127 # Backspace
         if !is_list && position > 0
           string = string[0...position - 1] + string[position..-1]
-          if words.nil?
+          if words.empty?
             position -= 1
             print "\b#{is_password ? "*" * (string.length - position) : string[position..-1]} #{"\b" * (string.length - position + 1)}"
           else
@@ -343,16 +385,6 @@ module FancyGets
             print "\b#{string[position..-1]}#{write_sugg.call}"
           end
         end
-      when 126 # Delete (forwards)
-        if !is_list && position < string.length
-          string = string[0...position] + string[position + 1..-1]
-          if words.nil?
-            print "#{is_password ? "*" * (string.length - position) : string[position..-1]} #{"\b" * (string.length - position + 1)}"
-          else
-            prev_sugg = sugg
-            print "#{string[position..-1]}#{write_sugg.call}"
-          end
-        end
       else # Insert character
         if is_list
           case ch
@@ -362,18 +394,27 @@ module FancyGets
               does_include = chosen.include?(position)
               is_rejected = false
               if on_change.is_a? Proc
-                response = on_change.call({chosen: chosen, changed: word_objects[position], is_chosen: !does_include})
+                # Generate what would happen if this change goes through
+                if does_include
+                  new_chosen = chosen - [position]
+                else
+                  new_chosen = chosen + [position]
+                end
+                chosen_objects = new_chosen.sort.map{|choice| word_objects[choice]}
+                response = on_change.call({chosen: chosen_objects, changed: word_objects[position], is_chosen: !does_include})
                 new_info = nil
                 if response.is_a? Hash
                   is_rejected = response[:is_rejected]
-                  chosen = response[:chosen] || chosen
+                  # If they told us exactly what the choices should now be, make that happen
+                  if response && response[:chosen].is_a?(Enumerable)
+                    chosen = response[:chosen].map {|choice| word_objects.index(choice)}
+                    is_rejected = true
+                  end
                   new_info = response[:info]
                 elsif response.is_a? String
                   new_info = response
                 end
-                unless new_info.nil?
-                  write_info.call(new_info)
-                end
+                write_info.call(new_info) if new_info
               end
               unless is_rejected
                 if does_include
@@ -383,6 +424,10 @@ module FancyGets
                 end
                 make_select.call(!does_include, true)
               end
+            else
+              # Allows Windows to have a way to at least use single-select lists
+              clear_dropdown_info.call
+              break
             end
           when "j"  # Down
             arrow_down.call
@@ -391,7 +436,7 @@ module FancyGets
           end
         else
           string = string[0...position] + ch + string[position..-1]
-          if words.nil?
+          if words.empty?
             ch = "*" if is_password
             position += 1
             print "#{ch}#{is_password ? "*" * (string.length - position) : string[position..-1]}#{"\b" * (string.length - position)}"
@@ -406,7 +451,7 @@ module FancyGets
 
     if is_list
       # Put chosen stuff in same order as it's listed in the words array
-      is_multiple ? chosen.map {|c| word_objects[c] } : word_objects[position]
+      is_multiple ? chosen.sort.map {|c| word_objects[c] } : word_objects[position]
     else
       sugg.empty? ? string : word_objects[words.index(sugg)]
     end

data/lib/fancy_gets/version.rb

@@ -1,3 +1,3 @@
 module FancyGets
-  VERSION = "0.1.5"
+  VERSION = "0.1.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fancy_gets
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.10
 platform: ruby
 authors:
 - Lorin Thwaits
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,9 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Enhanced gets with listbox, auto-complete, and password support
 test_files: []