Module: Kar::DSL

Defined in:
lib/kar/dsl.rb

Overview

DSLs you can use in your Rakefiles

Examples:

# Rakefile
require "kar/dsl"

SRC = FileList["src/**/*.md"]

# Defines file tasks for SRC
files SRC
file "book.epub" => SRC do |t|
  htmls = compile_markdowns(t.sources)
  package_epub(t.name, htmls)
end

# Downloads file from https://example.com/remote/file and save to local/file
download "local/file" => "https://example.org/remote/file"

# Build extension in Rust
cargo "my_gem"

Instance Method Summary collapse

Instance Method Details

#cargo(target) ⇒ Object

Declare a cargo task which builds extension in Rust by Cargo.

Also defines a cargo:check task which check sources and manifests. It’s useful to add them to the dependency of build task and prevent building invalid gem package.

Uses Gem::Ext::CargoBuilder internally unlike RbSys::ExtensionTask in order to build in the same way as ‘gem install` command, even though the output might be less usefull. When `RbSys::Extension` uses the same way, this function may be deprecated.

Examples:

# Rakefile
cargo "my_gem"

task build: "cargo:check"

# shell
% rake cargo



70
71
72
 
# File 'lib/kar/dsl.rb', line 70

def cargo(target)
  CargoTask.new target
end

#download(args) ⇒ Object

Examples:

# Rakefile
download "local/file" => "https://example.org/remote/file"
download "another/local/file" => URI("https://example.org/another/remote/file")

Include the tasks into dependency tree

# Rakefile
file "file.txt" => "local/file.txt.gz" do |t|
  sh "gunzip #{t.source}"
end
download "local/file.txt.gz" => "https://example.org/remote/file.txt.gz"

Raises:

  • (ArgumentError) —

    if URI scheme is unsupported



49
50
51
 
# File 'lib/kar/dsl.rb', line 49

def download(args)
  URITask.new args
end

#files(file_list) ⇒ Object 



26
27
28
29
30
 
# File 'lib/kar/dsl.rb', line 26

def files(file_list)
  file_list.each do |file_name|
    file file_name
  end
end