Class: Rake::Pipeline

Inherits:

Object

• Object
• Rake::Pipeline

show all

Defined in:

lib/rake-pipeline.rb,
lib/rake-pipeline/dsl.rb,
lib/rake-pipeline/error.rb,
lib/rake-pipeline/filter.rb,
lib/rake-pipeline/matcher.rb,
lib/rake-pipeline/version.rb,
lib/rake-pipeline/middleware.rb,
lib/rake-pipeline/file_wrapper.rb,
lib/rake-pipeline/filters/concat.rb

Overview

Rake::Pipeline.build do
  # process all js, css and html files in app/assets
  input "app/assets", "**/*.{js,coffee,css,scss,html}"

  # processed files should be outputted to public
  output "public"

  # process all coffee files
  match "*.coffee" do
    # compile all CoffeeScript files. the output file
    # for the compilation should be the input name
    # with the .coffee extension replaced with .js
    filter(CoffeeCompiler) do |input|
      input.sub(/\.coffee$/, '.js')
    end
  end

  # specify filters for js files. this includes the
  # output of the previous step, which converted
  # coffee files to js files
  match "*.js" do
    # first, wrap all JS files in a custom filter
    filter ClosureFilter
    # then, concatenate all JS files into a single file
    filter Rake::Pipeline::ConcatFilter, "application.js"
  end

  # specify filters for css and scss files
  match "*.{css,scss}" do
    # compile CSS and SCSS files using the SCSS
    # compiler. if an input file has the extension
    # scss, replace it with css
    filter(ScssCompiler) do |input|
      input.sub(/\.scss$/, 'css')
    end
    # then, concatenate all CSS files into a single file
    filter Rake::Pipeline::ConcatFilter, "application.css"
  end

  # the remaining files not specified by a matcher (the
  # HTML files) are simply copied over.

  # you can also specify filters here that will apply to
  # all processed files (application.js and application.css)
  # up until this point, as well as the HTML files.
end

Defined Under Namespace

Classes: ConcatFilter, DSL, EncodingError, Error, FileWrapper, Filter, Matcher, Middleware, UnopenedFile

Constant Summary

VERSION =

Version:

• 0.5.0

"0.5.0"

@@tmp_id =

0

Instance Attribute Summary (collapse)

• - (Array<FileWrapper>) input_files (also: #eligible_input_files)

  If you specify a glob for #input_glob, this method will calculate the input files for the directory.

• - (String) input_glob

  A glob representing the input files.

• - (String) input_root

  The directory path for the input files.

• - (Array<FileWrapper>) output_files readonly

  A list of the output files that invoking this pipeline will generate.

• - (String) output_root

  The directory path for the output files.

• - (Array) rake_tasks readonly

  An Array of Rake::Task objects.

• - (String) tmpdir

  The directory path for temporary files.

Class Method Summary (collapse)

• + (Rake::Pipeline) build(&block)

  Build a new pipeline taking a block.

Instance Method Summary (collapse)

• - (void) add_filters(*filters) (also: #add_filter)

  Add one or more filters to the current pipeline.

• - (Pipeline) copy(target_class = self.class, &block) private

  Copy the current pipeline's attributes over.

• - (Pipeline) initialize constructor

  A new instance of Pipeline.

• - (void) invoke

  Invoke the pipeline, processing the inputs into the output.

• - (void) invoke_clean

  Pick up any new files added to the inputs and process them through the filters.

• - (Rake::Application) rake_application

  The Rake::Application to install rake tasks onto.

• - (void) rake_application=(rake_application)

  Set the rake_application on the pipeline and apply it to filters.

• - (void) setup private

  Set up the filters and generate rake tasks.

119
120
121
122
123

# File 'lib/rake-pipeline.rb', line 119

def initialize
  @filters = []
  @tmpdir = "tmp"
  @mutex = Mutex.new
end

195
196
197
198
199
200
201
202
203
204
205
206
207

# File 'lib/rake-pipeline.rb', line 195

def input_files
  return @input_files if @input_files

  assert_input_provided

  expanded_root = File.expand_path(input_root)
  files = Dir[File.join(expanded_root, input_glob)].select { |f| File.file?(f) }

  files.map do |file|
    relative_path = file.sub(%r{^#{Regexp.escape(expanded_root)}/}, '')
    FileWrapper.new(expanded_root, relative_path)
  end
end

97
98
99

# File 'lib/rake-pipeline.rb', line 97

def input_glob
  @input_glob
end

100
101
102

# File 'lib/rake-pipeline.rb', line 100

def input_root
  @input_root
end

115
116
117

# File 'lib/rake-pipeline.rb', line 115

def output_files
  @filters.last.output_files unless @filters.empty?
end

103
104
105

# File 'lib/rake-pipeline.rb', line 103

def output_root
  @output_root
end

111
112
113

# File 'lib/rake-pipeline.rb', line 111

def rake_tasks
  @rake_tasks
end

106
107
108

# File 'lib/rake-pipeline.rb', line 106

def tmpdir
  @tmpdir
end

Rake::Pipeline.build do
  input "app/assets"
  output "public"

  filter Rake::Pipeline::ConcatFilter, "app.js"
end

143
144
145
146
147

# File 'lib/rake-pipeline.rb', line 143

def self.build(&block)
  pipeline = new
  DSL.evaluate(pipeline, &block) if block
  pipeline
end

232
233
234
235

# File 'lib/rake-pipeline.rb', line 232

def add_filters(*filters)
  filters.each { |filter| filter.rake_application = rake_application }
  @filters.concat(filters)
end

159
160
161
162
163
164
165

# File 'lib/rake-pipeline.rb', line 159

def copy(target_class=self.class, &block)
  pipeline = target_class.build(&block)
  pipeline.input_root = input_root
  pipeline.tmpdir = tmpdir
  pipeline.rake_application = rake_application
  pipeline
end

243
244
245
246
247
248
249
250
251
252

# File 'lib/rake-pipeline.rb', line 243

def invoke
  @mutex.synchronize do
    self.rake_application = Rake::Application.new unless @rake_application

    setup

    @rake_tasks.each { |task| task.recursively_reenable(rake_application) }
    @rake_tasks.each { |task| task.invoke }
  end
end

258
259
260
261

# File 'lib/rake-pipeline.rb', line 258

def invoke_clean
  @rake_tasks = @rake_application = nil
  invoke
end

215
216
217

# File 'lib/rake-pipeline.rb', line 215

def rake_application
  @rake_application || Rake.application
end

222
223
224
225
226

# File 'lib/rake-pipeline.rb', line 222

def rake_application=(rake_application)
  @rake_application = rake_application
  @filters.each { |filter| filter.rake_application = rake_application }
  @rake_tasks = nil
end

268
269
270
271

# File 'lib/rake-pipeline.rb', line 268

def setup
  setup_filters
  generate_rake_tasks
end