rake-tui 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc7cc20145ab71318914fd1b32c00da9e20337c548128a4f6cc8f84c753c5c6d
-  data.tar.gz: f3f5224f1879623d6977e7bb6dec008c0c545ff15f4b8aef2ff4db99118310b7
+  metadata.gz: 73bdc3fd5ddcd1b81d30090501aaca35359319f9c3b02be2683f63a613ea7995
+  data.tar.gz: ad8dffffc25cc90458a1edc1eea76a760181e65b905a96e8a0338e3eb3a8df64
 SHA512:
-  metadata.gz: 8c34001ed3bcaa9de37038d2730a6523203c8519cd99b408469a2feaa37825bb2c03e449e245f82504df78fc473aae97a2b7bb60787164de485d79f10361d881
-  data.tar.gz: 18e260dffd57d776ed3518968c92cd7078a8d074c9649a2f4bfd8075b78f57d0b512dc036808cf86e7a47d5e51f11cfc3d7241508af72e5a535adf2b675b694e
+  metadata.gz: 3550f1dbe5182179c1fb6ce75e0a4b594acb68e509af7d669d984c7b481b17edb0041f7108a89dca1e89cd2170d548723e6a635d71ffb1bf8526eff1f12611ea
+  data.tar.gz: 5d4d46df1f6943fe413b8c5adffc4ccf05e40e8575a7ca1498f6f19014dbbe508c504bfae0d40ec3023de90c33e6014e9b5db80a3339191028a764c2a090c64b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.2.1
+
+- `branding_header`, `prompt_question`, and `task_formatter` block options
+
 ## 0.2.0
 
 - Optimized performance for JRuby

data/README.md

@@ -93,6 +93,123 @@ 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.1 ==
+```
+
+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:
+
+```
+Choose a Rake 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)

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

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

@@ -5,6 +5,16 @@ 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)
@@ -15,13 +25,22 @@ module Rake
         end
       end
       
-      # Run TUI (recommended for general use)
-      def run
-        instance.run
+      # 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
     
-    # Initialize a new TUI object
+    # Initializes a new TUI object
     def initialize(tasks=Rake.application.tasks)
       if tasks.empty?
         Rake.application.init
@@ -29,20 +48,23 @@ module Rake
         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
+      @tasks = tasks.reject {|task| task.comment.nil?}
     end
   
-    # Run TUI
-    def run  
-      version = File.read(File.expand_path('../../../../../VERSION', __FILE__)).strip
-      puts "== rake-tui version #{version} =="
+    # 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?
           
-      unless @rake_task_lines&.detect {|l| l.start_with?('rake ')}
+      if @tasks.empty?
         puts "No Rake tasks found!"
         puts "Exiting..."
         exit(0)
@@ -58,12 +80,10 @@ module Rake
         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|
+      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, rake_task_lines, cycle: true, per_page: [TTY::Screen.height - 5, 1].max, filter: true, show_help: :always) do |list|
           list.singleton_class.define_method(:keyspace) do |event|
             return unless filterable?
       
@@ -74,9 +94,9 @@ module Rake
           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
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-tui
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - andy_maleh