rake-tui 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1092a4fede513e79f5e497319b6e28a1db283dad58082e8032128a35a8e00ac1
-  data.tar.gz: a7f6bc652016b1295fc88ff60e2ea3658d4f646d4c195a8ba9a3c8ac556f52d0
+  metadata.gz: bc7cc20145ab71318914fd1b32c00da9e20337c548128a4f6cc8f84c753c5c6d
+  data.tar.gz: f3f5224f1879623d6977e7bb6dec008c0c545ff15f4b8aef2ff4db99118310b7
 SHA512:
-  metadata.gz: 6c562c98c51b42d4b0e3a2ca524ef44726f27e37c1880527092601995818cd20a781c33b30b487c94ff1a4da0c5f51ab9001b7e331fc059c1eb17f594f4b4cf1
-  data.tar.gz: 1dd408ab34bd38289ff2a3b68a9347a3729564f752b2c4c1d5f447e47a325ca7810935e608e45c8fad7b66ab8fd563d24de423b144c6e10843a6ab408626eddc
+  metadata.gz: 8c34001ed3bcaa9de37038d2730a6523203c8519cd99b408469a2feaa37825bb2c03e449e245f82504df78fc473aae97a2b7bb60787164de485d79f10361d881
+  data.tar.gz: 18e260dffd57d776ed3518968c92cd7078a8d074c9649a2f4bfd8075b78f57d0b512dc036808cf86e7a47d5e51f11cfc3d7241508af72e5a535adf2b675b694e

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+## 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/)
@@ -34,6 +37,14 @@ rvm @global do gem install rake-tui
 Simply run this command:
 
 ```
+rakeui
+```
+
+Or one of the aliases:
+
+```
+rake-ui
+raketui
 rake-tui
 ```
 
@@ -44,9 +55,52 @@ If you are using [RVM](https://rvm.io/), then `rake-tui` works in [JRuby](https:
 Otherwise, simply run this command instead:
 
 ```
+jrakeui
+```
+
+Or one of the aliases:
+
+```
+jrake-ui
+jraketui
 jrake-tui
 ```
 
+## API
+
+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'
+```
+
+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
+```
+
+## 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.1
+0.2.0

data/bin/jrake-tui

@@ -1,3 +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,92 @@
+# frozen_string_literal: true
+
+require 'rake'
+Rake::TaskManager.record_task_metadata = true
+
+module Rake
+  class TUI
+    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
+      
+      # Run TUI (recommended for general use)
+      def run
+        instance.run
+      end
+    end
+    
+    # Initialize 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?}
+
+      max_task_size = !tasks.empty? && (tasks.map(&:name_with_args).map(&:size).max + 1)
+      @rake_task_lines = tasks.map do |task| 
+        "rake #{task.name_with_args.ljust(max_task_size)} # #{task.comment}"
+      end
+    end
+  
+    # Run TUI
+    def run  
+      version = File.read(File.expand_path('../../../../../VERSION', __FILE__)).strip
+      puts "== rake-tui version #{version} =="
+          
+      unless @rake_task_lines&.detect {|l| l.start_with?('rake ')}
+        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
+        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, show_help: :always, help: "(Press ↑/↓ arrow to move, Enter to select, CTRL+Enter to run without arguments, and letters to filter)") do |list|
+          list.singleton_class.define_method(:keyspace) do |event|
+            return unless filterable?
+      
+            if event.value = " "
+              @filter << event.value
+              @active = 1
+            end
+          end
+        end
+        
+        rake_task_with_args = rake_task_line.split('#').first.strip.split[1]
+        rake_task, rake_task_arg_names = rake_task_with_args.sub(']', '').split('[')
+        rake_task_arg_names = rake_task_arg_names&.split(',').to_a
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-tui
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - andy_maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -127,17 +127,32 @@ 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
 homepage: http://github.com/AndyObtiva/rake-tui
 licenses:
 - MIT