rake-tui 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49dc062ea430b2a65be5a69d587de76d0de3a87dacb7305c41d77db7ea55ddc4
-  data.tar.gz: d87e1c482e8abf53d5023c1a030493dc3816d3c621a225bfb68bc21a631bf427
+  metadata.gz: 4982123b5ac9d9339b1d753b92a8e234434f7dde48b4bb5e35931416950bde15
+  data.tar.gz: e7f6f3a898a75b40be96b88a7f37c22fe31c139eb85fe79f2d134a9180b1f7ef
 SHA512:
-  metadata.gz: 1c89b628e3f77dff0fa3d33fc516243fd9724e4bce59cba7c98815b6f9fe8a15a48af42825b076931080a70e7f73d946d354f34fdc9959a60e6e33de2ab61892
-  data.tar.gz: ed063cf1785f5006ad6ddd5667e27c0ad7702e16dd658ce48774f772419cb2316db30df99d161f06f2746e1b103848878ceb8f4d53c029c619ec37a567e26b52
+  metadata.gz: 358dccc0992f11ff52a99ab08746272c9fa28b9bef5738522b2d26a491ee1f804eb6f56cebd302656bc32346db7a20ef0102eff23b6828c145780840df07e266
+  data.tar.gz: 35b62d8deaf05e51a98f263ac3452bf7b134264454fac07e1cc312e0e9b9832e2584a38565ce776f94f2a3acbd8aa4f6d0e67ad5d4c61d425c0860ed4b401773

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Change Log
+
+## 0.2.3
+
+- Fixed issue with adding rake task list twice
+
+## 0.2.2
+
+- Improve compatibility with older tty-prompt v0.21.0 by setting select choices via block argument when using a block
+
+## 0.2.1
+
+- `branding_header`, `prompt_question`, and `task_formatter` block options
+
+## 0.2.0
+
+- Optimized performance for JRuby
+- rakeui, raketui, jrakeui, and jraketui shorter alternative commands
+- Enter arguments when a rake task needs them
+- Added an API for direct Ruby use
+- Specify/limit tasks displayed
+
+## 0.1.1
+
+- jrake-tui to support JRuby without RVM
+
+## 0.1.0
+
+- Initial version supporting listing and execution of rake tasks (without passing arguments)

data/README.md

@@ -5,6 +5,9 @@
 
 ![Rake TUI Demo](rake-tui-demo.gif)
 
+Other TUI gems you may be interested in:
+- [rvm-tui](https://github.com/AndyObtiva/rvm-tui)
+
 ## Pre-requisites
 
 - [Ruby](https://www.ruby-lang.org/en/)
@@ -20,7 +23,7 @@ gem install rake-tui
 ### Bundler
 
 ```ruby
-gem 'rake-tui'
+gem 'rake-tui', require: false
 ```
 
 ### [RVM](https://rvm.io/)
@@ -29,26 +32,192 @@ gem 'rake-tui'
 rvm @global do gem install rake-tui
 ```
 
+## Usage
+
+Simply run this command:
+
+```
+rakeui
+```
+
+Or one of the aliases:
+
+```
+rake-ui
+raketui
+rake-tui
+```
+
 ### [JRuby](https://www.jruby.org/)
 
-The `rake-tui` binary uses a `ruby` shebang: `#!/usr/bin/env ruby`
+If you are using [RVM](https://rvm.io/), then `rake-tui` works in [JRuby](https://www.jruby.org/) too.
 
-When using [JRuby](https://www.jruby.org/) with [RVM](https://rvm.io/), `ruby` is automatically symlinked as `jruby`, so `rake-tui` works fine.
+Otherwise, simply run this command instead:
+
+```
+jrakeui
+```
 
-To use `rake-tui` with [JRuby](https://www.jruby.org/) without [RVM](https://rvm.io/), you must create a symlink for `ruby` pointing to `jruby` as follows:
+Or one of the aliases:
 
 ```
-ln -s $(which jruby) $(dirname $(which jruby))/ruby
+jrake-ui
+jraketui
+jrake-tui
 ```
 
-## Usage
+## API
 
-Simply run this command:
+To use [rake-tui](https://rubygems.org/gems/rake-tui) as part of a Ruby app, require the [rake-tui](https://rubygems.org/gems/rake-tui) gem once at the top of your code:
 
+```ruby
+require 'rake-tui'
 ```
-rake-tui
+
+Afterwards, simply invoke the `Rake::TUI.run` method wherever you need to display the TUI to the user:
+
+```ruby
+Rake::TUI.run
+```
+
+If you'd rather specify or limit the tasks shown, then pass the tasks to the constructor before running:
+
+```ruby
+Rake::TUI.new(tasks).run
+```
+
+If you want to make that the default, then set the singleton instance:
+
+```ruby
+Rake::TUI.instance(Rake::TUI.new(tasks))
+Rake::TUI.run # this now displays the specified task list
+```
+
+## Options
+
+### `branding_header`
+
+The default branding header looks like this (from `Rake::TUI::BRANDING_HEADER_DEFAULT`):
+
+```
+== rake-tui version 0.2.3 ==
+```
+
+It may be customized by passing in the `branding_header` option (removed when set to `nil`).
+
+Example:
+
+```ruby
+Rake::TUI.run(branding_header: '== Glimmer (Ruby Desktop Development GUI Library) ==')
+```
+
+Output:
+
+```
+== Glimmer (Ruby Desktop Development GUI Library) ==
+```
+
+### `prompt_question`
+
+The prompt question is the text that shows up before the help message and looks like this (from `Rake::TUI::PROMPT_QUESTION_DEFAULT`):
+
+```
+Choose a Rake task:
+```
+
+It may be customized by passing in the `prompt_question` option:
+
+Example:
+
+```ruby
+Rake::TUI.run(prompt_question: 'Select a Glimmer task:')
+```
+
+Output:
+
+```
+Select a Glimmer task:  (Press ↑/↓ arrow to move, Enter to select and letters to filter)
 ```
 
+### `task_formatter` block
+
+The task formatter (default: `Rake::TUI::TASK_FORMATTER_DEFAULT`) is responsible for formatting
+tasks into task lines presented as choices to the user.
+
+It receives `task` and `tasks` list as options.
+
+For example, by default, it prints the same standard output you see from running `rake -T`:
+
+```
+  rake build               # Build gem into pkg/
+  rake clean               # Remove any temporary products
+  rake clobber             # Remove any generated files
+  rake clobber_rdoc        # Remove RDoc HTML files
+  rake console[script]     # Start IRB with all runtime dependencies loaded
+  rake gemcutter:release   # Release gem to Gemcutter
+  rake gemspec             # Generate and validate gemspec
+  rake gemspec:debug       # Display the gemspec for debugging purposes, as juwelier knows it (not from the filesystem)
+  rake gemspec:generate    # Regenerate the gemspec on the filesystem
+‣ rake gemspec:release     # Regenerate and validate gemspec, and then commits and pushes to git
+  rake gemspec:validate    # Validates the gemspec on the filesystem
+  rake git:release         # Tag and push release to git
+  rake install             # Build and install gem using `gem install`
+  rake rdoc                # Build RDoc HTML files
+  rake release             # Release gem
+  rake rerdoc              # Rebuild RDoc HTML files
+  rake simplecov           # Code coverage detail
+  rake spec                # Run RSpec code examples
+  rake version             # Displays the current version
+  rake version:bump:major  # Bump the major version by 1
+  rake version:bump:minor  # Bump the a minor version by 1
+  rake version:bump:patch  # Bump the patch version by 1
+  rake version:write       # Writes out an explicit version
+```
+
+However, it can be customized by passing in a `task_formatter` block.
+
+Example:
+
+```ruby
+Rake::TUI.new.run { |task, tasks| task.name_with_args }
+```
+
+Output:
+
+```
+  build
+  clean
+  clobber
+  clobber_rdoc
+  console[script]
+  gemcutter:release
+  gemspec
+  gemspec:debug
+  gemspec:generate
+  gemspec:release
+  gemspec:validate
+  git:release
+  install
+  rdoc
+‣ release
+  rerdoc
+  simplecov
+  spec
+  version
+  version:bump:major
+  version:bump:minor
+  version:bump:patch
+  version:write
+```
+
+## TODO
+
+[TODO.md](TODO.md)
+
+## Change Log
+
+[CHANGELOG.md](CHANGELOG.md)
+
 ## Contributing to rake-tui
 
 -   Check out the latest master to make sure the feature hasn't been

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.3

data/bin/jrake-tui

@@ -0,0 +1,25 @@
+#!/usr/bin/env jruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/jrake-ui

@@ -0,0 +1,25 @@
+#!/usr/bin/env jruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/jraketui

@@ -0,0 +1,25 @@
+#!/usr/bin/env jruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/jrakeui

@@ -0,0 +1,25 @@
+#!/usr/bin/env jruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/rake-tui

@@ -1,3 +1,25 @@
 #!/usr/bin/env ruby
 
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
 require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/rake-ui

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/raketui

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/bin/rakeui

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+require_relative '../lib/rake-tui.rb'
+Rake::TUI.run

data/lib/rake-tui.rb

@@ -1,44 +1,26 @@
-$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
-
-version = File.read(File.expand_path('../../VERSION', __FILE__)).strip
-puts "== rake-tui version #{version} =="
-
-require 'tty-prompt'
+# frozen_string_literal: true
 
-prompt = TTY::Prompt.new
-
-prompt.on(:keyescape) do |event|
-  puts # a new line is needed
-  puts "Exiting..."
-  exit(0)
-end
-
-begin
-  rake_task_lines = `rake -T`.split("\n")
-  unless rake_task_lines.detect {|l| l.start_with?('rake ')}
-    puts "No Rake tasks found!"
-    puts "Exiting..."
-    exit(0)
-  end
-  rake_task_lines = rake_task_lines.map do |line| 
-    bound = TTY::Screen.width - 6
-    line.size <= bound ? line : "#{line[0..(bound - 3)]}..."
-  end
-  rake_task_line = prompt.select("Choose a Rake task: ", rake_task_lines, cycle: true, per_page: [TTY::Screen.height - 5, 1].max, filter: true, help: true, show_help: :always) do |list|
-    list.singleton_class.define_method(:keyspace) do |event|
-      return unless filterable?
+# Copyright (c) 2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
-      if event.value = " "
-        @filter << event.value
-        @active = 1
-      end
-    end
-  end
-  rake_task = rake_task_line.split('#').first.strip
-  system rake_task
-rescue TTY::Reader::InputInterrupt => e
-  # No Op
-  puts # a new line is needed
-  puts "Exiting..."
-  exit(0)
-end
+require 'rake-tui/ext/rake/tui'

data/lib/rake-tui/ext/rake/tui.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'rake'
+Rake::TaskManager.record_task_metadata = true
+
+module Rake
+  class TUI
+    VERSION = File.read(File.expand_path('../../../../../VERSION', __FILE__)).strip
+    BRANDING_HEADER_DEFAULT = "== rake-tui version #{VERSION} =="
+    PROMPT_QUESTION_DEFAULT = "Choose a Rake task: "
+    TASK_FORMATTER_DEFAULT = lambda do |task, tasks|
+      max_task_size = tasks.map(&:name_with_args).map(&:size).max + 1
+      line = "rake #{task.name_with_args.ljust(max_task_size)} # #{task.comment}"
+      bound = TTY::Screen.width - 6
+      line.size <= bound ? line : "#{line[0..(bound - 3)]}..."
+    end
+  
+    class << self
+      # Singleton instance (if argument is specified, it is used to set instance)
+      def instance(tui=nil)
+        if tui.nil?
+          @instance ||= new
+        else
+          @instance = tui
+        end
+      end
+      
+      # Runs TUI (recommended for general use)
+      #
+      # Optionally takes a `branding_header` to customize the branding header or take it off when set to `nil`.
+      #
+      # Optionally takes a `prompt_question` to customize the question for selecting a rake task.
+      #
+      # Optionally pass a task_formatter mapping block to
+      # transform every rake task line into a different format
+      # e.g. Rake::TUI.new.run { |task, tasks| task.name_with_args }
+      # This makes tasks show up without `rake` prefix or `# description` suffix  
+      def run(branding_header: BRANDING_HEADER_DEFAULT, prompt_question: PROMPT_QUESTION_DEFAULT, &task_formatter)
+        instance.run(branding_header: branding_header, prompt_question: prompt_question, &task_formatter)
+      end
+    end
+    
+    # Initializes a new TUI object
+    def initialize(tasks=Rake.application.tasks)
+      if tasks.empty?
+        Rake.application.init
+        Rake.application.load_rakefile
+        tasks = Rake.application.tasks
+      end
+      
+      @tasks = tasks.reject {|task| task.comment.nil?}
+    end
+  
+    # Runs TUI
+    #
+    # Optionally takes a `branding_header` to customize the branding header or take it off when set to `nil`.
+    #
+    # Optionally takes a `prompt_question` to customize the question for selecting a rake task.
+    #
+    # Optionally takes a `task_formatter` mapping block to
+    # transform every rake task line into a different format
+    # e.g. Rake::TUI.new.run { |task, tasks| task.name_with_args }
+    # This makes tasks show up without `rake` prefix or `# description` suffix  
+    def run(branding_header: BRANDING_HEADER_DEFAULT, prompt_question: PROMPT_QUESTION_DEFAULT, &task_formatter)
+      puts branding_header unless branding_header.nil?
+          
+      if @tasks.empty?
+        puts "No Rake tasks found!"
+        puts "Exiting..."
+        exit(0)
+      end  
+      
+      require 'tty-prompt'
+      
+      prompt = TTY::Prompt.new
+
+      prompt.on(:keyescape) do |event|
+        puts # a new line is needed
+        puts "Exiting..."
+        exit(0)
+      end
+      
+      begin      
+        task_formatter ||= TASK_FORMATTER_DEFAULT
+        rake_task_lines = @tasks.map {|task, tasks| task_formatter.call(task, @tasks)}
+        rake_task_line = prompt.select(prompt_question, cycle: true, per_page: [TTY::Screen.height - 5, 1].max, filter: true, show_help: :always) do |list|
+          list.choices rake_task_lines
+          list.singleton_class.define_method(:keyspace) do |event|
+            return unless filterable?
+      
+            if event.value = " "
+              @filter << event.value
+              @active = 1
+            end
+          end
+        end
+        
+        selected_task = @tasks[rake_task_lines.index(rake_task_line)]
+        rake_task = selected_task.name
+        rake_task_arg_names = selected_task.arg_names
+        rake_task_arg_values = rake_task_arg_names.map do |rake_task_arg_name|
+          prompt.ask("Enter [#{rake_task_arg_name}] (default=nil):")
+        end
+        Rake::Task[rake_task].invoke(*rake_task_arg_values) # TODO support args
+      rescue TTY::Reader::InputInterrupt => e
+        # No Op
+        puts # a new line is needed
+        puts "Exiting..."
+        exit(0)
+      end  
+    end
+  end
+end

data/rake-tui.gemspec

@@ -0,0 +1,69 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: rake-tui 0.2.3 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rake-tui".freeze
+  s.version = "0.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["AndyMaleh".freeze]
+  s.date = "2020-09-24"
+  s.description = "Rake Text-based User Interface".freeze
+  s.email = "andy.am@gmail.com".freeze
+  s.executables = ["rake-tui".freeze, "jrake-tui".freeze, "raketui".freeze, "jraketui".freeze, "rake-ui".freeze, "jrake-ui".freeze, "rakeui".freeze, "jrakeui".freeze]
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md",
+    "VERSION",
+    "bin/jrake-tui",
+    "bin/jrake-ui",
+    "bin/jraketui",
+    "bin/jrakeui",
+    "bin/rake-tui",
+    "bin/rake-ui",
+    "bin/raketui",
+    "bin/rakeui",
+    "lib/rake-tui.rb",
+    "lib/rake-tui/ext/rake/tui.rb",
+    "rake-tui.gemspec"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/rake-tui".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.1.4".freeze
+  s.summary = "Rake TUI".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<tty-prompt>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_development_dependency(%q<bundler>.freeze, [">= 1.0"])
+    s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<e2mmap>.freeze, ["~> 0.1.0"])
+    s.add_development_dependency(%q<puts_debuggerer>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<tty-prompt>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, [">= 1.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<e2mmap>.freeze, ["~> 0.1.0"])
+    s.add_dependency(%q<puts_debuggerer>.freeze, [">= 0"])
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-tui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
-- andy_maleh
+- AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -126,16 +126,34 @@ description: Rake Text-based User Interface
 email: andy.am@gmail.com
 executables:
 - rake-tui
+- jrake-tui
+- raketui
+- jraketui
+- rake-ui
+- jrake-ui
+- rakeui
+- jrakeui
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - VERSION
+- bin/jrake-tui
+- bin/jrake-ui
+- bin/jraketui
+- bin/jrakeui
 - bin/rake-tui
+- bin/rake-ui
+- bin/raketui
+- bin/rakeui
 - lib/rake-tui.rb
+- lib/rake-tui/ext/rake/tui.rb
+- rake-tui.gemspec
 homepage: http://github.com/AndyObtiva/rake-tui
 licenses:
 - MIT