make_menu 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 220d243f1715ae665a12f8ed497f109209ba10fc5282298b7d9fec956ff99856
-  data.tar.gz: dd1adb0c2bed5934598a72e2b3d5ffc4c48477b438b2a1c6206351d742868e9e
+  metadata.gz: 8b6cd27b7d216d9aafab18ee1ada5756d4623a293bc659a6b16a01d71c95d180
+  data.tar.gz: 48f36e38f319a452675b3c45e8189e873d4679a71a8e8867684c8494cd850fff
 SHA512:
-  metadata.gz: e0f933ee0f3af0635c97dfc166e1c416784e0a5b24fac03cadab830179ed36fdce07711fc32e03ba353615de72128534b52d2cbf7b2e6009765043cb8bfb5d7e
-  data.tar.gz: 87c98103a07b39f4d54e4278042b5f110754ccad21b299b073928945b142c507636e1685ef811f2f93f9f52309b710876d052f0c23c1e7b6ceddbd918f1b9df5
+  metadata.gz: 3a3d2c60b794b93e27dfa7de7da5fd1bf75c5b385209b5c2ee571d881824cda532a36b6b2bcdb4dddb70684dcab426ea1a0c544ff724177ff3c0b3eee13bf45d
+  data.tar.gz: 8db18bd0530bc1118573efbe5d3df92663a8e52a9053d489118ec2ab3ceadc4f2e68427687809695de3ba0e6d41909c1f04f89feb675ca3acfae3afc96c1ca0e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    make_menu (1.1.0)
+    make_menu (2.1.0)
       tty-screen (~> 0.8.2)
 
 GEM

data/lib/make_menu/badge_set.rb

@@ -1,15 +1,29 @@
+# frozen_string_literal: true
+
 module MakeMenu
+  # A set of BADGES to display above the menu
   class BadgeSet
     def initialize
       @badges = []
     end
 
+    # Add a new badge to the set
+    # @param [String] label Optional label to print to the left of the badge value
+    # @param [Proc] block Block to run each time the menu is re-drawn
+    def add(label = '', &block)
+      @badges << {
+        label: label,
+        handler: block
+      }
+    end
+
+    # Print badges in a wrapping horizontal row
     def display
       rows = []
       row = ''
       @badges.each do |badge|
         label = badge[:label]
-        value = badge[:handler].call ? badge[:on] : badge[:off]
+        value = badge[:handler].call
         if row.decolor.size + label.decolor.size + value.decolor.size >= (0.7 * ::TTY::Screen.cols)
           rows << row
           row = ''
@@ -21,14 +35,5 @@ module MakeMenu
       puts rows.join("\n\n").align_block(:center)
       puts
     end
-
-    def add(label = '', on: ' ON '.green_bg.bold, off: ' OFF '.red_bg.dark, &block)
-      @badges << {
-        label: label,
-        on: on,
-        off: off,
-        handler: block
-      }
-    end
   end
 end

data/lib/make_menu/builder.rb

@@ -2,6 +2,7 @@
 
 module MakeMenu
   module Builder
+    # Parse `makefile` and add all annotated targets to `menu`
     def self.build(makefile, menu)
       File.open(makefile, 'r') do |file|
         option_number = 1

data/lib/make_menu/console/prompter.rb

@@ -7,10 +7,29 @@ module MakeMenu
     module Prompter
       PressedEscape = Class.new(StandardError)
 
-      def self.prompt(text = '', obscure: false)
-        print text
+      def self.prompt_and_save(text, file:, obscure: false)
+        if file.is_a? Symbol
+          file = ".#{file}"
+        end
+
+        current = File.exists?(file) ? File.read(file).strip : ''
+
+        response = prompt(text, input: current, obscure: obscure)
+
+        if response.empty?
+          File.delete(file) if File.exists?(file)
+        else
+          File.write(file, response)
+        end
+
+        return response
+      end
+
+      def self.prompt(text = '', input: '', obscure: false, value_color: :light_yellow)
+        text = text.bold
+
+        print "\r#{text}#{input.color(value_color)}"
 
-        input = ''
         char = ''
 
         until !char.empty? && char.ord == 13
@@ -21,11 +40,17 @@ module MakeMenu
             # BACKSPACE
             input = input[0..-2]
             print "\r#{text}#{' ' * input.size} "
-            print "\r#{text}#{obscure ? '*' * input.size : input}"
+            print "\r#{text}#{obscure ? '*'.color(value_color) * input.size : input.color(value_color)}"
 
           when 27
             # ESC
-            raise PressedEscape
+            raise PressedEscape if input.empty?
+
+            print "\r#{text}#{' ' * input.size} "
+            print "\r#{text}"
+
+            input = ''
+            char = ''
 
           when 13
             # ENTER
@@ -33,13 +58,16 @@ module MakeMenu
           else
             input += char
             if obscure
-              print '*'
+              print '*'.color(value_color)
             else
-              print char
+              print char.color(value_color)
             end
           end
         end
 
+        print "\r#{text}#{' ' * input.size} "
+        print "\r#{text}"
+
         input
       end
     end

data/lib/make_menu/field_set.rb

@@ -1,10 +1,46 @@
+# frozen_string_literal: true
+
 module MakeMenu
+  # A set of FIELDS to display above the menu
   class FieldSet
     def initialize
       @fields = []
       @max_widths = {}
     end
 
+    # Add a new field to the set
+    # @param [String] label Optional label to print to the left of the field value
+    # @param [String,Symbol] value_from_file If set, read the field value from a file
+    #   in the current directory. A String is used literally, a Symbol is assumed
+    #   to be a hidden file (i.e. starts with `.`)
+    # @param [String,Symbol,Integer] color Formatting to apply to the value
+    # @param [String] none Text to display if the file does not exist, or is empty
+    # @param [Proc] block Block to return the value to display
+    def add(label = '', value_from_file: nil, color: :normal, none: '[none]'.dark, &block)
+      if value_from_file
+        if value_from_file.is_a? Symbol
+          value_from_file = ".#{value_from_file}"
+        end
+        block = lambda do
+          if File.exists? value_from_file
+            value = File.read(value_from_file).strip
+
+            return none if value.empty?
+
+            return value.color(color)
+          else
+            return none
+          end
+        end
+      end
+
+      @fields << {
+        label: label,
+        handler: block
+      }
+    end
+
+    # Print fields in an aligned vertical stack
     def display
       build
       @fields.each do |field|
@@ -12,20 +48,23 @@ module MakeMenu
                        .align(
                          :right,
                          width: @max_widths[:label]
-                       ).color(field[:label_color])
+                       )
 
         value_cel = field[:value]
                       .align(
                         :left,
                         width: @max_widths[:value],
                         pad_right: true
-                      ).color(field[:value_color])
+                      )
 
         puts "#{label_cell}#{value_cel}".align(:center)
       end
       puts
     end
 
+    private
+
+    # Calculate maximum sizes of labels and rendered values
     def build
       @max_widths[:label] = 0
       @max_widths[:value] = 0
@@ -39,14 +78,5 @@ module MakeMenu
         @max_widths[:value] = value_width if value_width > @max_widths[:value]
       end
     end
-
-    def add(label = nil, label_color: :normal, value_color: :normal, &block)
-      @fields << {
-        label: label || '',
-        label_color: label_color,
-        value_color: value_color,
-        handler: block
-      }
-    end
   end
 end

data/lib/make_menu/menu.rb

@@ -20,7 +20,8 @@ module MakeMenu
       @options = {
         group_title_color: :underline,
         clear_screen: true,
-        pause_on_success: false
+        pause_on_success: false,
+        badges_first: true
       }
       @highlights = {}
 
@@ -40,8 +41,14 @@ module MakeMenu
         system 'clear' if clear_screen?
 
         display_header
-        display_badges
-        display_fields
+
+        if badges_first?
+          display_badges
+          display_fields
+        else
+          display_fields
+          display_badges
+        end
 
         puts colorize(MakeMenu::Text::Table.new(groups).to_s)
         puts
@@ -93,8 +100,8 @@ module MakeMenu
       end
     end
 
-    def add_field(field, &block)
-      fields.add field, &block
+    def add_field(label = '', value_from_file: nil, color: :normal, none: '[none]'.dark, &block)
+      fields.add label, value_from_file: value_from_file, color: color, none: none, &block
     end
 
     def fields
@@ -105,8 +112,8 @@ module MakeMenu
       @field_set.display if @field_set
     end
 
-    def add_badge(label = '', on: ' ON '.green_bg.bold, off: ' OFF '.red_bg.dark, &block)
-      badges.add label, on: on, off: off, &block
+    def add_badge(label = '', &block)
+      badges.add label, &block
     end
 
     def badges
@@ -149,6 +156,10 @@ module MakeMenu
       options[:pause_on_success]
     end
 
+    def badges_first?
+      options[:badges_first]
+    end
+
     def colorize(text)
       highlights.each do |word, color|
         case color

data/lib/make_menu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MakeMenu
-  VERSION = '1.1.0'
+  VERSION = '2.1.0'
 end

data/lib/make_menu.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'make_menu/console/prompter'
 require_relative 'make_menu/console/color_string'
 require_relative 'make_menu/menu'
 
@@ -13,4 +14,39 @@ module MakeMenu
   def self.run(makefile = './Makefile', &block)
     MakeMenu::Menu.new(makefile).run(&block)
   end
+
+  def self.prompt(text = nil, obscure: false, value_from_file: nil)
+    if (preamble = ARGV[0])
+      if text.nil?
+        if preamble.include?("\n")
+          parts = preamble.split("\n")
+          preamble = parts[0..-2].join("\n")
+          text = parts[-1]
+          puts preamble
+        else
+          text = preamble
+        end
+      end
+    end
+
+    if value_from_file
+      begin
+        input = Console::Prompter.prompt_and_save text, file: value_from_file, obscure: obscure
+        puts (obscure ? ('*' * input.decolor.size) : input).green.underline
+
+      rescue Console::Prompter::PressedEscape
+        puts '(not updated)'.red
+      end
+    else
+      begin
+        input = Console::Prompter.prompt text, obscure: obscure
+        puts (obscure ? ('*' * input.decolor.size) : input).green.underline
+        $stderr.puts input
+      rescue Console::Prompter::PressedEscape
+        puts '(not updated)'.red
+      end
+    end
+
+    input
+  end
 end

data/make_menu.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     'Gemfile.lock'
   ]
   s.homepage =
-    'https://github.com/MisterGrimalkin/make_menu'
+    'https://github.com/MixterGrimalkin/make_menu'
   s.license = 'MIT'
   s.add_dependency 'tty-screen', '~> 0.8.2'
   s.description = ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: make_menu
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Barri Mason
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -45,7 +45,7 @@ files:
 - lib/make_menu/text/table.rb
 - lib/make_menu/version.rb
 - make_menu.gemspec
-homepage: https://github.com/MisterGrimalkin/make_menu
+homepage: https://github.com/MixterGrimalkin/make_menu
 licenses:
 - MIT
 metadata: {}