make_menu 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6709a0676bcc3bca7afa26690fb7efd8048006c48bf96edd1697941e685762dd
-  data.tar.gz: 213d207ec9167cd91fcfcfeb0fce94772109ed3cad93a778280c9607d5f30b6a
+  metadata.gz: 032edeb7018b672422a335bdcda50129603efe7f9fd6fda7ec2411d12c029e4c
+  data.tar.gz: 0c2481bfc18b982e5d834d81ebb7c1a1388ef2e6086121044badcf01be38c4b8
 SHA512:
-  metadata.gz: e3e6ce5aa039336be1d51a98e305075b4fc41747063f77f07bd3d73199f5d929b854c2b26057429962a4a12b0b5ff65a5f2fd0105e0680fe8e887a2173bb1e6d
-  data.tar.gz: 5826d84e6da06b2fcae5e53206d6e7a1056899ad060b8ad64b559e6d770914aa332d08bf53170c1e80953f747404acc6c66bf6cc73c4b4e3166cb9e34fd77686
+  metadata.gz: 870f6926e1c56c1731a3cf5de5814aeb8885aaeb82446359f9405522230c42395da5c9e61d11f5f776349b0e42453e6b4df7981e1c48d1284d0301292ef747bf
+  data.tar.gz: 52c3cb4ab593115ff1274cdb4996a3c7ab2ebfab89db344d4be7922a0cc3de6efb255d18695cac180037bee994e3668e766aafb5ccd99c708023260d700b73ff

data/Gemfile

@@ -3,3 +3,7 @@
 source 'http://rubygems.org'
 
 gemspec
+
+group :development do
+  gem 'bump'
+end

data/Gemfile.lock

@@ -1,16 +1,20 @@
 PATH
   remote: .
   specs:
-    make_menu (0.0.1)
+    make_menu (0.1.0)
+      tty-screen (~> 0.8.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    bump (0.10.0)
+    tty-screen (0.8.2)
 
 PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  bump
   make_menu!
 
 BUNDLED WITH

data/lib/make_menu/menu.rb

@@ -12,12 +12,10 @@ module MakeMenu
     def initialize(makefile)
       @groups = []
       @items = []
-      @status_present = false
       build makefile
     end
 
     attr_reader :groups, :items
-    attr_accessor :status_present
 
     # Display menu and prompt for command
     # rubocop:disable Metrics/MethodLength
@@ -48,7 +46,6 @@ module MakeMenu
     # Display the company logo and the status bar (if set)
     def display_header
       puts formatted_logo if logo
-      puts `make status` if status_present
     end
 
     private
@@ -76,14 +73,8 @@ module MakeMenu
             # Target 'menu' should not appear
             next if target == 'menu'
 
-            # Target 'status' should not appear, but is run automatically when the menu is rendered
-            if target == 'status'
-              self.status_present = true
-              next
-            end
-
             unless current_group
-              current_group = MenuItemGroup.new
+              current_group = MenuItemGroup.new('Commands'.color(group_title_color))
               groups << current_group
             end
 
@@ -94,7 +85,25 @@ module MakeMenu
             option_number += 1
           end
         end
+
+        if option_number == 1
+          puts
+          puts 'No annotated targets found!'.red.bold
+          puts
+          puts 'Expecting something like this....'
+          puts "    #{'my_target:'.cyan} #{'## Do some things'.yellow}"
+          puts
+          exit 1
+        end
       end
+
+    rescue Errno::ENOENT => _e
+      puts
+      puts 'No Makefile!'.red.bold
+      puts
+      puts "File '#{makefile}' could not be found.".yellow
+      puts
+      exit 1
     end
 
     # rubocop:enable Metrics/MethodLength
@@ -144,21 +153,19 @@ module MakeMenu
 
     # Get the menu logo from the LOGO constant
     def logo
-      return "\n#{' make '.black_bg.light_yellow}#{' menu '.light_yellow_bg.black}\n".bold unless Object.const_defined?("#{self.class.name}::LOGO")
+      return "\n#{"  #{Dir.pwd.split('/').last}  ".light_yellow_bg.black.bold}\n \n" unless Object.const_defined?("#{self.class.name}::LOGO")
 
       Object.const_get("#{self.class.name}::LOGO")
     end
 
     protected
 
-    # Override the following methods to customise the menu display
-
-    # @return [Symbol] Color for group title
+    # @return [Symbol,Array[Symbol]] Color for group title
     def group_title_color
-      :light_green
+      %i[yellow bold]
     end
 
-    # Clean screen before and after each command
+    # Clear screen before and after each command
     def clear_screen?
       true
     end

data/lib/make_menu/version.rb

@@ -1,3 +1,3 @@
 module MakeMenu
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/lib/make_menu.rb

@@ -1,6 +1,5 @@
 require_relative 'make_menu/color_string'
 require_relative 'make_menu/menu'
-require_relative 'make_menu/status_panel'
 
 require 'tty-screen'
 
@@ -19,18 +18,17 @@ module MakeMenu
     else
       MakeMenu::Menu.new(makefile).run
     end
-  rescue LoadError => _e
-    puts "ERROR! Expected file ./#{menu_name.downcase}_menu.rb to define class #{menu_name.capitalize}Menu < MakeMenu::Menu"
-  end
 
-  def self.status
-    if (menu_name = ENV.fetch('MENU', nil))
-      require "./#{menu_name.downcase}_status_panel.rb"
-      Object.const_get("#{menu_name.capitalize}StatusPanel").new.display
-    else
-      MakeMenu::StatusPanel.new.display
-    end
-  rescue LoadError => _e
-    puts "ERROR! Expected file ./#{menu_name.downcase}_status_panel.rb to define class #{menu_name.capitalize}StatusPanel < MakeMenu::StatusPanel"
+  rescue LoadError, NameError => _e
+    puts
+    puts 'No customisation class found!'.red.bold
+    puts
+    puts 'Expected file:'
+    puts "    ./#{menu_name.downcase}_menu.rb".cyan
+    puts
+    puts 'To define class:'
+    puts "    #{menu_name.capitalize}Menu < MakeMenu::Menu".yellow
+    puts
+    exit 1
   end
 end

data/make_menu.gemspec

@@ -16,44 +16,5 @@ Gem::Specification.new do |s|
     "https://rubygems.org/gems/make_menu"
   s.license = "MIT"
   s.add_dependency 'tty-screen', '~> 0.8.2'
-  s.description = %(
-Creates a number-selection menu from a Makefile. The menu will attempt to fill the width of the terminal window.
-
-- Any targets in the Makefile with a double-hash comment will be displayed, e.g.:
-    serve: ## Start Rails server in background
-  This will display a line such as '1. Start Rails server in background' which runs the command `make serve`.
-
-- A line that starts with a triple-hash will create a new menu group, e.g.:
-    ### Docker Commands
-  This will begin a new group with the header 'Docker Commands'
-
-- The environment variable MENU can be used to specify a custom menu class, e.g.:
-    export MENU=Accounts
-  This assumes that a class `AccountsMenu` is defined in the file `accounts_menu.rb`
-
-  You can define two constants in your custom class:
-    LOGO (String) text or ASCII art to display above the menu
-    HIGHLIGHTS (Hash{String=>[Symbol,Array<Symbol>]}) Add coloring to specific words or phrases
-
-- The environment variable MAKEFILE can specify a Makefile. The default is './Makefile'.
-
-The menu will not display any targets called 'menu' or 'status'. The latter, if present, is called each
-time the menu displays.
-
------------------------------
-Docker Container Status Panel
------------------------------
-
-Displays a color-coded panel indicating whether or not a Docker container is running.
-
-You must define a custom class inheriting from `MakeMenu::StatusPanel` and indicate this using
-the environment variable MENU, e.g.:
-    export MENU=Accounts
-This assumes that a class `AccountsStatusPanel` is defined in the file `accounts_status_panel.rb`
-
-You can define a constant CONTAINERS {String=>String} in this custom class to map the displayed
-label to the container name, e.g.:
-    CONTAINERS = { 'Backend' => 'myapp-backend-1' }
-
-)
+  s.description = ""
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: make_menu
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Barri Mason
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -24,46 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.2
-description: |2+
-
-  Creates a number-selection menu from a Makefile. The menu will attempt to fill the width of the terminal window.
-
-  - Any targets in the Makefile with a double-hash comment will be displayed, e.g.:
-      serve: ## Start Rails server in background
-    This will display a line such as '1. Start Rails server in background' which runs the command `make serve`.
-
-  - A line that starts with a triple-hash will create a new menu group, e.g.:
-      ### Docker Commands
-    This will begin a new group with the header 'Docker Commands'
-
-  - The environment variable MENU can be used to specify a custom menu class, e.g.:
-      export MENU=Accounts
-    This assumes that a class `AccountsMenu` is defined in the file `accounts_menu.rb`
-
-    You can define two constants in your custom class:
-      LOGO (String) text or ASCII art to display above the menu
-      HIGHLIGHTS (Hash{String=>[Symbol,Array<Symbol>]}) Add coloring to specific words or phrases
-
-  - The environment variable MAKEFILE can specify a Makefile. The default is './Makefile'.
-
-  The menu will not display any targets called 'menu' or 'status'. The latter, if present, is called each
-  time the menu displays.
-
-  -----------------------------
-  Docker Container Status Panel
-  -----------------------------
-
-  Displays a color-coded panel indicating whether or not a Docker container is running.
-
-  You must define a custom class inheriting from `MakeMenu::StatusPanel` and indicate this using
-  the environment variable MENU, e.g.:
-      export MENU=Accounts
-  This assumes that a class `AccountsStatusPanel` is defined in the file `accounts_status_panel.rb`
-
-  You can define a constant CONTAINERS {String=>String} in this custom class to map the displayed
-  label to the container name, e.g.:
-      CONTAINERS = { 'Backend' => 'myapp-backend-1' }
-
+description: ''
 email: loki@amarantha.net
 executables: []
 extensions: []
@@ -76,7 +37,6 @@ files:
 - lib/make_menu/menu.rb
 - lib/make_menu/menu_item.rb
 - lib/make_menu/menu_item_group.rb
-- lib/make_menu/status_panel.rb
 - lib/make_menu/text_column.rb
 - lib/make_menu/text_table.rb
 - lib/make_menu/version.rb
@@ -105,4 +65,3 @@ signing_key:
 specification_version: 4
 summary: Generates an interactive menu from a Makefile
 test_files: []
-...

data/lib/make_menu/status_panel.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'color_string'
-require 'readline'
-
-module MakeMenu
-  # A panel above the menu displaying the status of Docker containers.
-  # The mapping of TextLabel => ContainerName must be defined in a constant called CONTAINERS
-  class StatusPanel
-    String.include(ColorString)
-
-    # Print panel
-    def display
-      return if containers.empty?
-
-      puts "\n#{panel}"
-    end
-
-    protected
-
-    # Return a hash mapping label to container name
-    # This is assumed to be provided as a constant called CONTAINERS
-    # @return [Hash{String=>String}]
-    def containers
-      Object.const_get "#{self.class.name}::CONTAINERS"
-    rescue NameError
-      {}
-    end
-
-    # Override this to change the colors for running / not running
-    def colors_if_running
-      {
-        true => %i[green_bg bold white],
-        false => %i[red_bg bold dark]
-      }.freeze
-    end
-
-    # Override this to limit each row to a maximum number of labels
-    def max_labels_per_line
-      containers.size
-    end
-
-    private
-
-    # @return [String] Text representation of the panel
-    # rubocop:disable Metrics/MethodLength
-    def panel
-      return @panel if @panel
-
-      return "- Docker offline -\n".grey.dark.align(:center) unless docker_online?
-
-      @panel = ''
-      labels_on_this_line = 0
-      line_buffer = ''
-
-      containers.each do |label, container|
-        if (labels_on_this_line + 1) > labels_per_line
-          @panel += "#{left_indent(labels_on_this_line)}#{line_buffer}\n\n"
-          labels_on_this_line = 0
-          line_buffer = ''
-        end
-
-        text = label.align(:center, width: max_label_width, pad_right: true)
-                    .color(colors_if_running[running?(container)])
-
-        line_buffer += " #{text} "
-
-        labels_on_this_line += 1
-      end
-
-      @panel += "#{left_indent(labels_on_this_line)}#{line_buffer}\n\n"
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def docker_online?
-      system 'docker', 'compose', 'ps', out: File::NULL, err: File::NULL
-    end
-
-    # @return [String] List of Docker containers and information
-    def docker_ps
-      @docker_ps ||= `docker compose ps`
-    end
-
-    # @return [Boolean] whether specified container is running
-    def running?(container)
-      docker_ps.include? container
-    end
-
-    # Return the left indent for this line of labels
-    # @param [Integer] number_of_labels Number of labels on this line
-    # @return [String]
-    def left_indent(number_of_labels)
-      spaces = (::TTY::Screen.cols - (number_of_labels * (max_label_width + 2))) / 2
-      spaces = [spaces, 0].max
-      ' ' * spaces
-    end
-
-    # @return [Integer] Maximum label width, with padding
-    def max_label_width
-      @max_label_width ||= containers.map do |label, _container|
-        label.length
-      end.max + 2
-    end
-
-    # @return [Integer] Number of labels that can fit on one line
-    def labels_per_line
-      @labels_per_line ||= [
-        (::TTY::Screen.cols / max_label_width) - 1,
-        max_labels_per_line
-      ].min
-    end
-  end
-end