run_tasks 3.1.3 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83bdaff7d74bf3104dd2610ab19cbf7666591f8a08cba2527b22fec0ddd7909f
-  data.tar.gz: f6d121239d0faf3c899a94589a2c7af506e3392347dc782ec2361c738083f8c6
+  metadata.gz: d9a68d0e13118096e666e14fe7d9017555028b5fb3aa03501b2f818fa459528c
+  data.tar.gz: 548eb3281cadebf9282dcecbe7336916b2026751cfa1fee1294e3cd709160b43
 SHA512:
-  metadata.gz: 22d7c77617c5c825be18c61ed18558880790c325f2936a7e394138b912be2807d05a976a95f2f1f309bd492ab72d2b58cca65b0420626fcfe31671b1ade5ec18
-  data.tar.gz: e65c02340150c8065790cd635e7d97566f5908a0990932402dfe623634904c6d0a048176482f93018f3eb7a0cd53ac090d3e133eb9446cf0a36fd8b4c3b6ec1d
+  metadata.gz: 40c8dcc4c1a5521202b367e56da1afa60e5da97acddfdd516a5ebce791471b8092161d7e44c9550be80bc80326671d4466f33e080f134735479fa08c67d83204
+  data.tar.gz: a88efe99f700e0bf1bf70e79c12a494afa411f1a3429ce7aaf330ba2f8dadc78e98c12ad1df82d08551ef668b8a51ec1b5ee180c499d9b881166dd8cc2fc9828

data/CHEATSHEET.md

@@ -0,0 +1,212 @@
+# Run cheatsheet
+
+## Defining a task
+
+```rb
+task :eslint do
+end
+```
+
+## Defining a task with aliases
+
+```rb
+task [:console, :c] do
+end
+```
+
+## Defining a task with parameters
+
+```rb
+task :hello do |name, age|
+  puts "Hello #{name}, you are #{age}."
+end
+```
+
+## Running commands
+
+```rb
+task :clear_all do
+  run "rm -rf /*"
+end
+```
+
+## Running subtasks
+
+```rb
+task :linting do
+  run :eslint
+  run :rubocop
+end
+```
+
+## Running a task/command in quiet mode
+
+```rb
+task :clear_cache do
+  run "rm -rf cache/*", quiet: true
+end
+```
+
+## Using named booleans
+
+```sh
+run server +tunnel
+```
+
+```rb
+task :server do |tunnel: false|
+  run "http_server #{tunnel ? "--tunnel" : ""}"
+end
+```
+
+## Helpers
+
+### are_you_sure
+
+```rb
+task :dangerous_task do
+  are_you_sure "This task will delete your hard drive. Are you sure about that?"
+  # Some dangerous actions.
+end
+```
+
+### bind
+
+```rb
+task :dev do
+  bind :rails, :vite
+end
+
+task :rails do
+  run "bundle exec unicorn -c config/unicorn.rb -p 3000"
+end
+
+task :vite do
+  run "bin/vite dev"
+end
+```
+
+### catch_interruption
+
+```rb
+task :server do
+  catch_interruption("docker run -d -p 8080:80 web_server") do
+    run :clear_cache
+  end
+end
+```
+
+### exists
+
+```rb
+task :man do
+  command = exists("bat") ? "bat" : "cat"
+  run "#{command} #{__dir__}/README.md"
+end
+```
+
+### expand
+
+```rb
+task :scan do |glob|
+  expand(glob).each do |file_path|
+    puts file_path
+  end
+end
+```
+
+### menu
+
+```rb
+task :deploy_aws do
+  region = menu "Location?", ["us‑east‑2", "us-west-1", "eu-west-1"]
+end
+```
+
+```rb
+task :deploy_aws do
+  region = menu "Location?", {
+    "US East (Ohio)" => "us‑east‑2",
+    "US West (N. California)" => "us-west-1",
+    "Europe (Ireland)" => "eu-west-1",
+  }
+end
+```
+
+### pause
+
+```rb
+task :deploy do
+  puts "Press enter to continue.".yellow
+  pause
+  run :deploy_production
+end
+```
+
+### question
+
+```rb
+task :survey do
+  comment = question "Did your meal was good?"
+end
+```
+
+```rb
+task :age do
+  age = question "What is your age?", /^\d+$/
+end
+```
+
+### wait_for_interruption
+
+```rb
+task :server do
+  Thread.new do
+    run :rails
+  end
+  Thread.new do
+    run :vite
+  end
+  wait_for_interruption do
+    run :kill_rails
+    run :kill_vite
+  end
+end
+```
+
+## Colorization
+
+```rb
+puts "hello".bold
+puts "hello".dim
+puts "hello".italic
+puts "hello".underline
+puts "hello".inverse
+puts "hello".strikethrough
+puts "hello".black
+puts "hello".red
+puts "hello".green
+puts "hello".yellow
+puts "hello".blue
+puts "hello".magenta
+puts "hello".cyan
+puts "hello".white
+puts "hello".bright_black
+puts "hello".bright_red
+puts "hello".bright_green
+puts "hello".bright_yellow
+puts "hello".bright_blue
+puts "hello".bright_magenta
+puts "hello".bright_cyan
+puts "hello".bright_white
+```
+
+```rb
+puts "hello".green.bold.italic
+```
+
+## Advanced usage
+
+```sh
+RUNFILE=/path/to/Runfile.rb run my_task
+```

data/src/bootstrap.rb

@@ -77,6 +77,12 @@ task :publish do
   `rm #{gemspec.name}-#{gemspec.version}.gem`
 end
 
+# Display the manual.
+task :man do
+  command = exists("bat") ? "bat" : "cat"
+  run "#{command} #{__dir__}/../CHEATSHEET.md"
+end
+
 # Expose helpers.
 Dir.glob(File.join(__dir__, "run", "helper", "*.rb")) do |path|
   filename = File.basename(path, ".rb")

data/src/run/helper/are_you_sure_helper.rb

@@ -5,7 +5,7 @@ module Run
     class AreYouSureHelper
       # @param message [String]
       def initialize(message = "Are you sure?")
-        raise ArgumentError.new("'message' must be a String") if !message.is_a?(String)
+        raise ArgumentError.new("'message' must be a String") unless message.is_a?(String)
         @message = message
       end
 

data/src/run/helper/exists_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Run
+  module Helper
+    class ExistsHelper
+      # @param program [String]
+      def initialize(program)
+        raise ArgumentError.new("'program' must be a String") unless program.is_a?(String)
+
+        @program = program
+      end
+
+      # @return [Boolean]
+      def run
+        system("which", @program, out: File::NULL, err: File::NULL)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: run_tasks
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.1
 platform: ruby
 authors:
 - Aurélien Delogu
@@ -71,6 +71,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHEATSHEET.md
 - bin/run
 - completions/_run
 - src/bootstrap.rb
@@ -86,6 +87,7 @@ files:
 - src/run/helper/are_you_sure_helper.rb
 - src/run/helper/bind_helper.rb
 - src/run/helper/catch_interruption_helper.rb
+- src/run/helper/exists_helper.rb
 - src/run/helper/expand_helper.rb
 - src/run/helper/menu_helper.rb
 - src/run/helper/pause_helper.rb