Class: Middleman::Builder

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Contracts
Defined in:
lib/middleman-core/builder.rb

Constant Summary collapse

SORT_ORDER =

Sort order, images, fonts, js/css and finally everything else.

%w(.png .jpeg .jpg .gif .bmp .svg .svgz .webp .ico .woff .woff2 .otf .ttf .eot .js .css).freeze

Constants included from Contracts

Contracts::PATH_MATCHER

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Contracts

#Contract

Constructor Details

#initialize(app, opts = {}) ⇒ Builder

Create a new Builder instance.

Parameters:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/middleman-core/builder.rb', line 29

def initialize(app, opts={})
  @app = app
  @source_dir = Pathname(File.join(@app.root, @app.config[:source]))
  @build_dir = Pathname(@app.config[:build_dir])

  if @build_dir.expand_path.relative_path_from(@source_dir).to_s =~ /\A[.\/]+\Z/
    raise ":build_dir (#{@build_dir}) cannot be a parent of :source_dir (#{@source_dir})"
  end

  @glob = opts.fetch(:glob)
  @cleaning = opts.fetch(:clean)
  @parallel = opts.fetch(:parallel, true)

  rack_app = ::Middleman::Rack.new(@app).to_app
  @rack = ::Rack::MockRequest.new(rack_app)

  @callbacks = ::Middleman::CallbackManager.new
  @callbacks.install_methods!(self, [:on_build_event])
end

Instance Attribute Details

#app ⇒ Object (readonly)

Make app & events available to after_build callbacks.



15
16
17
 
# File 'lib/middleman-core/builder.rb', line 15

def app
  @app
end

#events ⇒ Object (readonly)

Make app & events available to after_build callbacks.



15
16
17
 
# File 'lib/middleman-core/builder.rb', line 15

def events
  @events
end

#thor ⇒ Object

Reference to the Thor class.



18
19
20
 
# File 'lib/middleman-core/builder.rb', line 18

def thor
  @thor
end

Instance Method Details

#Any

This method returns an undefined value.

Get a list of all the paths in the destination folder and save them for comparison against the files we build in this cycle



246
 
# File 'lib/middleman-core/builder.rb', line 246

Contract Any

#binary_encode(string) ⇒ Object 



284
285
286
287
 
# File 'lib/middleman-core/builder.rb', line 284

def binary_encode(string)
  string.force_encoding('ascii-8bit') if string.respond_to?(:force_encoding)
  string
end

#Bool ⇒ Boolean

Run the build phase.

Returns:

  • (Boolean) —

    Whether the build was successful.



51
 
# File 'lib/middleman-core/builder.rb', line 51

Contract Bool

#clean! ⇒ Object 



272
273
274
275
276
277
278
279
280
281
 
# File 'lib/middleman-core/builder.rb', line 272

def clean!
  to_remove = @to_clean.reject do |f|
    app.config[:skip_build_clean].call(f.to_s)
  end

  to_remove.each do |f|
    FileUtils.rm(f)
    trigger(:deleted, f)
  end
end

#export_file!(output_file, source) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/middleman-core/builder.rb', line 189

def export_file!(output_file, source)
  # ::Middleman::Util.instrument "write_file", output_file: output_file do
  source = write_tempfile(output_file, source.to_s) if source.is_a? String

  method, source_path = if source.is_a? Tempfile
    [::FileUtils.method(:mv), source.path]
  else
    [::FileUtils.method(:cp), source.to_s]
  end

  mode = which_mode(output_file, source_path)

  if mode == :created || mode == :updated
    ::FileUtils.mkdir_p(output_file.dirname)
    method.call(source_path, output_file.to_s)
  end

  source.unlink if source.is_a? Tempfile

  trigger(mode, output_file)
  # end
end

#output_files ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/middleman-core/builder.rb', line 112

def output_files
  logger.debug '== Building files'

  resources = @app.sitemap.resources
                  .reject { |resource| resource.ext == '.css' }
                  .sort_by { |resource| SORT_ORDER.index(resource.ext) || 100 }

  if @glob
    resources = resources.select { |resource| File.fnmatch(@glob, resource.destination_path) }
  end

  output_resources(resources)
end

#output_resource(resource) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/middleman-core/builder.rb', line 216

def output_resource(resource)
  ::Middleman::Util.instrument 'builder.output.resource', path: File.basename(resource.destination_path) do
    output_file = @build_dir + resource.destination_path.gsub('%20', ' ')

    begin
      if resource.binary?
        export_file!(output_file, resource.file_descriptor[:full_path])
      else
        response = @rack.get(::URI.escape(resource.request_path))

        # If we get a response, save it to a tempfile.
        if response.status == 200
          export_file!(output_file, binary_encode(response.body))
        else
          trigger(:error, output_file, response.body)
          return false
        end
      end
    rescue => e
      trigger(:error, output_file, "#{e}\n#{e.backtrace.join("\n")}")
      return false
    end

    output_file
  end
end

#output_resources(resources) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/middleman-core/builder.rb', line 127

def output_resources(resources)
  results = if @parallel
    ::Parallel.map(resources, &method(:output_resource))
  else
    resources.map(&method(:output_resource))
  end

  @has_error = true if results.any? { |r| r == false }

  if @cleaning && !@has_error
    results.each do |p|
      next unless p.exist?

      # handle UTF-8-MAC filename on MacOS
      cleaned_name = if RUBY_PLATFORM =~ /darwin/
        p.to_s.encode('UTF-8', 'UTF-8-MAC')
      else
        p
      end

      @to_clean.delete(Pathname(cleaned_name))
    end
  end

  resources
end

#Pathname

This method returns an undefined value.

Actually export the file.

Parameters:

  • output_file (Pathname) —

    The path to output to.

  • source (String|Pathname) —

    The source path or contents.



158
 
# File 'lib/middleman-core/builder.rb', line 158

Contract Pathname, String => Symbol

#prerender_css ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/middleman-core/builder.rb', line 90

def prerender_css
  logger.debug '== Prerendering CSS'

  css_files = ::Middleman::Util.instrument 'builder.prerender.output' do
    resources = @app.sitemap.resources.select { |resource| resource.ext == '.css' }
    output_resources(resources)
  end

  ::Middleman::Util.instrument 'builder.prerender.check-files' do
    # Double-check for compass sprites
    if @app.files.find_new_files!.length > 0
      logger.debug '== Checking for Compass sprites'
      @app.sitemap.ensure_resource_list_updated!
    end
  end

  css_files
end

#queue_current_paths ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/middleman-core/builder.rb', line 247

def queue_current_paths
  @to_clean = []

  return unless File.exist?(@app.config[:build_dir])

  paths = ::Middleman::Util.all_files_under(@app.config[:build_dir]).map do |path|
    Pathname(path)
  end

  @to_clean = paths.select do |path|
    path.realpath.relative_path_from(@build_dir.realpath).to_s !~ /\/\./ || path.to_s =~ /\.(htaccess|htpasswd)/
  end

  # handle UTF-8-MAC filename on MacOS
  @to_clean = @to_clean.map do |path|
    if RUBY_PLATFORM =~ /darwin/
      Pathname(path.to_s.encode('UTF-8', 'UTF-8-MAC'))
    else
      Pathname(path)
    end
  end
end

#ResourceList ⇒ Array<Resource>

Find all the files we need to output and do so.

Returns:

  • (Array<Resource>) —

    List of resources that were output.



89
 
# File 'lib/middleman-core/builder.rb', line 89

Contract ResourceList

#run! ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/middleman-core/builder.rb', line 52

def run!
  @has_error = false
  @events = {}

  ::Middleman::Util.instrument 'builder.before' do
    @app.execute_callbacks(:before_build, [self])
  end

  ::Middleman::Util.instrument 'builder.queue' do
    queue_current_paths if @cleaning
  end

  ::Middleman::Util.instrument 'builder.prerender' do
    prerender_css
  end

  ::Middleman::Profiling.start

  ::Middleman::Util.instrument 'builder.output' do
    output_files
  end

  ::Middleman::Profiling.report('build')

  ::Middleman::Util.instrument 'builder.clean' do
    clean! if @cleaning
  end

  ::Middleman::Util.instrument 'builder.after' do
    @app.execute_callbacks(:after_build, [self])
  end

  !@has_error
end

#trigger(event_type, target, extra = nil) ⇒ Object 



290
291
292
293
294
295
 
# File 'lib/middleman-core/builder.rb', line 290

def trigger(event_type, target, extra=nil)
  @events[event_type] ||= []
  @events[event_type] << target

  execute_callbacks(:on_build_event, [event_type, target, extra])
end

#which_mode(output_file, source) ⇒ Object 



159
160
161
162
163
164
165
 
# File 'lib/middleman-core/builder.rb', line 159

def which_mode(output_file, source)
  if !output_file.exist?
    :created
  else
    FileUtils.compare_file(source.to_s, output_file.to_s) ? :identical : :updated
  end
end

#write_tempfile(output_file, contents) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/middleman-core/builder.rb', line 172

def write_tempfile(output_file, contents)
  file = Tempfile.new([
                        File.basename(output_file),
                        File.extname(output_file)
                      ])
  file.binmode
  file.write(contents)
  file.close
  File.chmod(0644, file)
  file
end