Guard is My Best Friend

Coding, Design — Tags: Guard — Posted by Starck on June 24, 2013

Guardfile 語法說明

guard :<plugin> : 使用 plugin
group :<group name> … end : 定義一個 task 分類區塊
%w[] : Ruby 宣告 Array 的方式, 用空白區分
:key => value : 宣告 Hashes 的 key/value
%r{} : Regexen 正規表達式, 可到 rubular 測試

Group

example:

group :tb2 do
    guard :concat, 
        :type => 'css', :files = > %w[boostrap bootstrap-responsive], 
        :input_dir => 'app/assets/css,
        :output => 'public/css/bootstrap.css
end

group :zf4 do
    guard :concat, 
        :type => 'css', :files = > %w[normalize foundation4], 
        :input_dir => 'app/assets/css,
        :output => 'public/css/foundation.css
end

group :tb2 do

guard :concat,

:type => 'css', :files = > %w[boostrap bootstrap-responsive],

:input_dir => 'app/assets/css,

:output => 'public/css/bootstrap.css

end

group :zf4 do

guard :concat,

:type => 'css', :files = > %w[normalize foundation4],

:input_dir => 'app/assets/css,

:output => 'public/css/foundation.css

end

Plugins

CoffeeScript

guard-coffeescript

編譯 CoffeeScript

input : .coffee 路徑
output : .javascript 輸出路徑

example:

guard :coffeescript, 
    :input => "app/assets/coffee", 
    :output => "public/js"

guard :coffeescript,

:input => "app/assets/coffee",

:output => "public/js"

Concat

guard-concat

合併檔案

type : 檔案類型 (副檔名), ex: css, js…
files : 哪些檔案要被合併, 用 Array 的方式定義
input_dir : 來源路徑
output : 合併後的檔案 (去除.副檔名)

example:

guard :concat, 
    :type => "css", 
    :files => %w[bootstrap-responsive bootstrap button], 
    :input_dir => "public/css", 
    :output => "public/css/styles.min"

guard :concat,

:type => "css",

:files => %w[bootstrap-responsive bootstrap button],

:input_dir => "public/css",

:output => "public/css/styles.min"

# This will concatenate the javascript files a.js and b.js in public/js to all.js
guard :concat, type: "js", files: %w(b a), input_dir: "public/js", output: "public/js/all"

# analog css example
guard :concat, type: "css", files: %w(c d), input_dir: "public/css", output: "public/css/all"

# js example with *

guard :concat, type: "js", files: %w(vendor/* b a), input_dir: "public/js", output: "public/js/all"
# will concatenate all files in the vendor dir, then b then a (watch out of dependencies)

# This will concatenate the javascript files a.js and b.js in public/js to all.js

guard :concat, type: "js", files: %w(b a), input_dir: "public/js", output: "public/js/all"

# analog css example

guard :concat, type: "css", files: %w(c d), input_dir: "public/css", output: "public/css/all"

# js example with *

guard :concat, type: "js", files: %w(vendor/* b a), input_dir: "public/js", output: "public/js/all"

# will concatenate all files in the vendor dir, then b then a (watch out of dependencies)

Livereload

guard-livereload

Blocks/Closures
watch : 偵測什麼的檔案變化, 可以用 %r 正規表達式

example:

# .+       任意字元
# (?<!)    zero-width negative look-behind assertion.
# (?<!\.min\.(css|html|js|blade\.php)$)
# 不包含 .min 文字但以 css 或 html 或 js 或 blade.php 結尾

guard 'livereload' do
    watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})
end

# .+ 任意字元

# (?<!) zero-width negative look-behind assertion.

# (?<!\.min\.(css|html|js|blade\.php)$)

# 不包含 .min 文字但以 css 或 html 或 js 或 blade.php 結尾

guard 'livereload' do

watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})

end

可用參數:

:host => '127.3.3.1'     # default '0.0.0.0'
:port => '12345'         # default '35729'
:apply_css_live => false # default true
:override_url => false   # default false
:grace_period => 0.5     # default 0 (seconds)

:host => '127.3.3.1' # default '0.0.0.0'

:port => '12345' # default '35729'

:apply_css_live => false # default true

:override_url => false # default false

:grace_period => 0.5 # default 0 (seconds)

example:

guard 'livereload', :host => '127.3.3.1', :port => '12345' do
    watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})
end

guard 'livereload', :host => '127.3.3.1', :port => '12345' do

watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})

end

Minify

cssmin
jsmin

example:

min_js = 'public/js/bootstrap.min.js'
watch 'public/js/bootstrap.js' do |m|
  js = File.read(m[0])
  File.open(min_js, 'w') { |file| file.write(JSMin.minify(js)) }
  puts min_js + " has minify."
end

min_js = 'public/js/bootstrap.min.js'

watch 'public/js/bootstrap.js' do |m|

js = File.read(m[0])

File.open(min_js, 'w') { |file| file.write(JSMin.minify(js)) }

puts min_js + " has minify."

end

watch('public/css/styles.min.css') do |m|
    css = File.read(m[0])
    File.open(m[0], 'w') { |file| file.write(CSSMin.minify(css)) }
end
watch('public/js/scripts.min.js') do |m|
    js = File.read(m[0])
    File.open(m[0], 'w') { |file| file.write(JSMin.minify(js)) }
end

watch('public/css/styles.min.css') do |m|

css = File.read(m[0])

File.open(m[0], 'w') { |file| file.write(CSSMin.minify(css)) }

end

watch('public/js/scripts.min.js') do |m|

js = File.read(m[0])

File.open(m[0], 'w') { |file| file.write(JSMin.minify(js)) }

end

PHP Unit Testing

# 
# PHP Unit Testing
# 
guard :shell, :all_on_start => false do
  watch(%r{^app/tests/.+Test\.php$}) { `phpunit` }
end

# PHP Unit Testing

guard :shell, :all_on_start => false do

watch(%r{^app/tests/.+Test\.php$}) { `phpunit` }

end

參考完整 Guardfile 範例

Laravel-Guard Example:

guard :coffeescript, :input => "app/assets/coffee", :output => "public/js"

guard :concat, :type => "css", :files => %w[bootstrap-responsive bootstrap button], :input_dir => "public/css", :output => "public/css/styles.min"

guard :concat, :type => "js", :files => %w[bootstrap], :input_dir => "public/js", :output => "public/js/scripts.min"

# Refresh the browser on save
guard 'livereload' do
  watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})
end

guard :phpunit, :all_on_start => false, :tests_path => 'app/tests/', :cli => '--colors -c phpunit.xml' do
  # Run any test in app/tests upon save.
  watch(%r{^.+Test\.php$})

  # When a view file is updated, run tests.
  # Tip: you probably only want to run your integration tests.
  watch(%r{app/views/.+\.php}) { Dir.glob('app/tests/**/*.php') }

  # When a file is edited, try to run its associated test.
  # Save app/models/User.php, and it will run app/tests/models/UserTest.php
  watch(%r{^app/(.+)/(.+)\.php$}) { |m| "app/tests/#{m[1]}/#{m[2]}Test.php"}
end

module ::Guard
  class Refresher < Guard
    def run_all
      # refresh
    end

    def run_on_additions(paths)
      refresh
    end

    def run_on_removals(paths)
      refresh
    end

    def refresh
      `php artisan guard:refresh`
    end
  end
end

require 'cssmin'
require 'jsmin'

guard :refresher do
  watch(%r[public/js/.+])
  watch(%r[public/css/.+])
  watch(%r{app/config/packages/way/guard-laravel/guard.php}) do |m|
    `php artisan guard:refresh`
  end
  watch('public/css/styles.min.css') do |m|
    css = File.read(m[0])
    File.open(m[0], 'w') { |file| file.write(CSSMin.minify(css)) }
  end
  watch('public/js/scripts.min.js') do |m|
    js = File.read(m[0])
    File.open(m[0], 'w') { |file| file.write(JSMin.minify(js)) }
  end
end

guard :sass, :input => 'app/assets/sass', :output => 'public/css'

guard :coffeescript, :input => "app/assets/coffee", :output => "public/js"

guard :concat, :type => "css", :files => %w[bootstrap-responsive bootstrap button], :input_dir => "public/css", :output => "public/css/styles.min"

guard :concat, :type => "js", :files => %w[bootstrap], :input_dir => "public/js", :output => "public/js/scripts.min"

# Refresh the browser on save

guard 'livereload' do

watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})

end

guard :phpunit, :all_on_start => false, :tests_path => 'app/tests/', :cli => '--colors -c phpunit.xml' do

# Run any test in app/tests upon save.

watch(%r{^.+Test\.php$})

# When a view file is updated, run tests.

# Tip: you probably only want to run your integration tests.

watch(%r{app/views/.+\.php}) { Dir.glob('app/tests/**/*.php') }

# When a file is edited, try to run its associated test.

# Save app/models/User.php, and it will run app/tests/models/UserTest.php

watch(%r{^app/(.+)/(.+)\.php$}) { |m| "app/tests/#{m[1]}/#{m[2]}Test.php"}

end

module ::Guard

class Refresher < Guard

def run_all

# refresh

end

def run_on_additions(paths)

refresh

end

def run_on_removals(paths)

refresh

end

def refresh

`php artisan guard:refresh`

end

require 'cssmin'

require 'jsmin'

guard :refresher do

watch(%r[public/js/.+])

watch(%r[public/css/.+])

watch(%r{app/config/packages/way/guard-laravel/guard.php}) do |m|

`php artisan guard:refresh`

end

watch('public/css/styles.min.css') do |m|

css = File.read(m[0])

File.open(m[0], 'w') { |file| file.write(CSSMin.minify(css)) }

end

watch('public/js/scripts.min.js') do |m|

js = File.read(m[0])

File.open(m[0], 'w') { |file| file.write(JSMin.minify(js)) }

end

guard :sass, :input => 'app/assets/sass', :output => 'public/css'

My Laravel Example :

require 'cssmin'
require 'jsmin'

group :tb2 do

  all_js = 'bootstrap.all'
  all_css = 'bootstrap.all'

  min_js = 'public/js/bootstrap.min.js'
  min_css = 'public/css/bootstrap.min.css'

  # Compile CoffeeScript
  guard :coffeescript, :input => "app/assets/coffee", :output => "app/assets/js"

  # Compile SASS
  guard :sass, :input => 'app/assets/sass', :output => 'app/assets/css'

  # Concat CSS
  guard :concat, :type => "css", :files => %w[bootstrap bootstrap-responsive button], :input_dir => "app/assets/css", :output => "public/css/" + all_css

  # Concat JS
  guard :concat, :type => "js", :files => %w[jquery.1.9.1 bootstrap jqBootstrapValidation], :input_dir => "app/assets/js", :output => "public/js/" + all_js

  # 
  # Minify JS
  # 
  watch 'public/js/'+ all_js +'.js' do |m|
    js = File.read(m[0])
    File.open(min_js, 'w') { |file| file.write(JSMin.minify(js)) }
    puts min_js + " has minify."
  end

  # 
  # Minify CSS
  # 
  watch 'public/css/'+ all_css +'.css' do |m|
    css = File.read(m[0])
    File.open(min_css, 'w') { |file| file.write(CSSMin.minify(css)) }
    puts min_css + " has minify."
  end

end

# 
# Live Reload
# 

guard 'livereload' do
  watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})
end

# 
# PHP Unit Testing
# 

guard :phpunit, :all_on_start => false, :tests_path => 'app/tests/', :cli => '--colors -c phpunit.xml' do
  # Run any test in app/tests upon save.
  watch(%r{^.+Test\.php$})

  # When a view file is updated, run tests.
  # Tip: you probably only want to run your integration tests.
  watch(%r{app/views/.+\.php}) { Dir.glob('app/tests/**/*.php') }

  # When a file is edited, try to run its associated test.
  # Save app/models/User.php, and it will run app/tests/models/UserTest.php
  watch(%r{^app/(.+)/(.+)\.php$}) { |m| "app/tests/#{m[1]}/#{m[2]}Test.php"}
end

require 'cssmin'

require 'jsmin'

group :tb2 do

all_js = 'bootstrap.all'

all_css = 'bootstrap.all'

min_js = 'public/js/bootstrap.min.js'

min_css = 'public/css/bootstrap.min.css'

# Compile CoffeeScript

guard :coffeescript, :input => "app/assets/coffee", :output => "app/assets/js"

# Compile SASS

guard :sass, :input => 'app/assets/sass', :output => 'app/assets/css'

# Concat CSS

guard :concat, :type => "css", :files => %w[bootstrap bootstrap-responsive button], :input_dir => "app/assets/css", :output => "public/css/" + all_css

# Concat JS

guard :concat, :type => "js", :files => %w[jquery.1.9.1 bootstrap jqBootstrapValidation], :input_dir => "app/assets/js", :output => "public/js/" + all_js

# Minify JS

watch 'public/js/'+ all_js +'.js' do |m|

js = File.read(m[0])

File.open(min_js, 'w') { |file| file.write(JSMin.minify(js)) }

puts min_js + " has minify."

end

# Minify CSS

watch 'public/css/'+ all_css +'.css' do |m|

css = File.read(m[0])

File.open(min_css, 'w') { |file| file.write(CSSMin.minify(css)) }

puts min_css + " has minify."

end

# Live Reload

guard 'livereload' do

watch(%r{.+(?<!\.min)\.(css|html|js|blade\.php)$})

end

# PHP Unit Testing

guard :phpunit, :all_on_start => false, :tests_path => 'app/tests/', :cli => '--colors -c phpunit.xml' do

# Run any test in app/tests upon save.

watch(%r{^.+Test\.php$})

# When a view file is updated, run tests.

# Tip: you probably only want to run your integration tests.

watch(%r{app/views/.+\.php}) { Dir.glob('app/tests/**/*.php') }

# When a file is edited, try to run its associated test.

# Save app/models/User.php, and it will run app/tests/models/UserTest.php

watch(%r{^app/(.+)/(.+)\.php$}) { |m| "app/tests/#{m[1]}/#{m[2]}Test.php"}

end

Comments (0)