Module: Gumdrop

Defined in:
lib/gumdrop.rb,
lib/gumdrop/cli.rb,
lib/gumdrop/data.rb,
lib/gumdrop/site.rb,
lib/gumdrop/server.rb,
lib/gumdrop/builder.rb,
lib/gumdrop/content.rb,
lib/gumdrop/version.rb,
lib/gumdrop/renderer.rb,
lib/gumdrop/generator.rb,
lib/gumdrop/util/loggable.rb,
lib/gumdrop/util/view_helpers.rb,
lib/gumdrop/util/proxy_handler.rb

Overview

require ‘ostruct’

Defined Under Namespace

Modules: CLI, Data, Support, Util Classes: Builder, Content, ContentList, ContextPool, DataManager, Generator, RenderContext, RenderPool, Renderer, Server, Site, SpecialContentList

Constant Summary collapse

WEB_PAGE_EXTS = 
%w(.html .htm)
JETSAM_FILES = 
%w(**/.DS_Store .git* .git/**/* .svn/**/* **/.sass-cache/**/* Gumdrop)
DEFAULT_CONFIG = 
{
  relative_paths: true,
  relative_paths_exts: WEB_PAGE_EXTS,
  default_layout: 'site',
  layout_exts: WEB_PAGE_EXTS,
  proxy_enabled: false,
  output_dir: "./output",
  source_dir: "./source",
  data_dir: './data',
  log: STDOUT,
  log_level: :info,
  ignore: JETSAM_FILES,
  blacklist: [],
  no_render: [],
  server_timeout: 5,
  server_port: 4567,
  env: :production,
  file_change_test: :checksum
}
STATIC_ASSETS = 
%w(.jpg .jpe .jpeg .gif .ico .png .swf)
VERSION = 
"1.1.3"
LOG_LEVELS = 
{
    debug: Logger::DEBUG,
     info: Logger::INFO,
     warn: Logger::WARN,
    error: Logger::ERROR,
    fatal: Logger::FATAL,
  unknown: Logger::UNKNOWN
}

Class Method Summary collapse

Class Method Details

.blacklist(*paths) ⇒ Object

Specified paths will not be rendered to output (matching against the source tree).



366
367
368
369
370
371
372
373
374
 
# File 'lib/gumdrop/site.rb', line 366

def blacklist(*paths)
  paths.each do |path|
    if path.is_a? Array
      config.blacklist.concat path
    else
      config.blacklist << path
    end
  end      
end

.build(opts = {}) ⇒ Object 



144
145
146
147
148
 
# File 'lib/gumdrop/builder.rb', line 144

def build(opts={})
  opts= opts.to_symbolized_hash
  site.scan
  Builder.new(opts).execute
end

.change_log ⇒ Object

Returns ‘ChangeLog.md’ from gem package.



36
37
38
39
 
# File 'lib/gumdrop.rb', line 36

def self.change_log
  here= File.dirname(__FILE__)
  File.read here / ".." / "ChangeLog.md"
end

.cli(&block) ⇒ Object

Allows addition of CLI commands from Gumdrop file:

Gumdrop.cli do
  desc 'ping'
  method_option :loud, default:false
  def ping
    say options[:loud] ? 'PONG!' : 'pong'
  end
end



15
16
17
 
# File 'lib/gumdrop/cli.rb', line 15

def cli(&block)
  CLI::Internal.class_eval &block
end

.config ⇒ Object

Short cut to the current Site config object.



331
332
333
 
# File 'lib/gumdrop/site.rb', line 331

def config
  site.config
end

.configure(&block) ⇒ Object

Yield a configuration object. You can update Gumdrop behavior as well as add your own config information.



322
323
324
 
# File 'lib/gumdrop/site.rb', line 322

def configure(&block)
  site.configure &block
end

.env ⇒ Object

The env Gumdrop is run in – You can set this in the config or, better, via command line: ‘gumdrop build -e test`



337
338
339
 
# File 'lib/gumdrop/site.rb', line 337

def env
  site.env
end

.generate(name = nil, opts = {}, &block) ⇒ Object

Generate a page (based on data or whatever) from your Gumdrop file like this:

Gumdrop.generate 'label' do |gen|
  gen.file 'my-page.html' do
    # whatever you return is set as the page contents.
    "hello!"
  end
end



140
141
142
143
 
# File 'lib/gumdrop/generator.rb', line 140

def generate(name=nil, opts={}, &block)
  opts[:filename]= name unless opts[:filename]
  site.generators << Generator.new(nil, opts, &block)
end

.handle_proxy(proxy, proxy_url, env) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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/gumdrop/util/proxy_handler.rb', line 26

def self.handle_proxy(proxy, proxy_url, env)
  if proxy[:secure] && !HTTPS_ENABLED
    log.warn "~ WARNING: HTTPS is not supported on your system, using HTTP instead.\n"
    log.warn "   If you are using Ubuntu, you can run `apt-get install libopenssl-ruby`\n"
    proxy[:secure] = false
  end

  origin_host = env['SERVER_NAME'] # capture the origin host for cookies
  http_method = env['REQUEST_METHOD'].to_s.downcase
  url = proxy[:path_info] #proxy_url #env['PATH_INFO']
  params = env['QUERY_STRING']
  
  log.info "PROXY: -> #{url}"

  # collect headers...
  headers = {}
  env.each do |key, value|
    next unless key =~ /^HTTP_/
    key = key.gsub(/^HTTP_/,'').downcase.sub(/^\w/){|l| l.upcase}.gsub(/_(\w)/){|l| "-#{$1.upcase}"} # remove HTTP_, dasherize and titleize
    if !key.eql? "Version"
      headers[key] = value
    end
  end

  # Rack documentation says CONTENT_TYPE and CONTENT_LENGTH aren't prefixed by HTTP_
  headers['Content-Type'] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']

  length = env['CONTENT_LENGTH']
  headers['Content-Length'] = length if length

  http_host, http_port = proxy[:to].split(':')
  http_port = proxy[:secure] ? '443' : '80' if http_port.nil?

  # added 4/23/09 per Charles Jolley, corrects problem
  # when making requests to virtual hosts
  headers['Host'] = "#{http_host}:#{http_port}"

  if proxy[:url]
    url = url.sub(/^#{Regexp.escape proxy_url}/, proxy[:url])
  end

  http_path = [url]
  http_path << params if params && params.size>0
  http_path = http_path.join('?')

  response = nil
  no_body_method = %w(get copy head move options trace)

  done = false
  tries = 0
  until done
    http = ::Net::HTTP.new(http_host, http_port)

    if proxy[:secure]
      http.use_ssl = true
      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    end

    http.start do |web|
      if no_body_method.include?(http_method)
        response = web.send(http_method, http_path, headers)
      else
        http_body = env['rack.input']
        http_body.rewind # May not be necessary but can't hurt

        req = Net::HTTPGenericRequest.new(http_method.upcase,
                                            true, true, http_path, headers)
        req.body_stream = http_body if length.to_i > 0
        response = web.request(req)
      end
    end

    status = response.code # http status code
    protocol = proxy[:secure] ? 'https' : 'http'

    log.info "~ PROXY: #{http_method.upcase} #{status} #{url} -> #{protocol}://#{http_host}:#{http_port}#{http_path}\n"

    # display and construct specific response headers
    response_headers = {}
    ignore_headers = ['transfer-encoding', 'keep-alive', 'connection']
    response.each do |key, value|
      next if ignore_headers.include?(key.downcase)
      # If this is a cookie, strip out the domain.  This technically may
      # break certain scenarios where services try to set cross-domain
      # cookies, but those services should not be doing that anyway...
      value.gsub!(/domain=[^\;]+\;? ?/,'') if key.downcase == 'set-cookie'
      # Location headers should rewrite the hostname if it is included.
      value.gsub!(/^http:\/\/#{http_host}(:[0-9]+)?\//, "http://#{http_host}/") if key.downcase == 'location'
      # content-length is returning char count not bytesize
      if key.downcase == 'content-length'
        if response.body.respond_to?(:bytesize)
          value = response.body.bytesize.to_s
        elsif response.body.respond_to?(:size)
          value = response.body.size.to_s
        else
          value = '0'
        end
      end

      #$stderr << "   #{key}: #{value}\n"

      response_headers[key] = value
    end

    if [301, 302, 303, 307].include?(status.to_i) && proxy[:redirect] != false
      log.warn '~ REDIRECTING: '+response_headers['location']+"\n"

      uri = URI.parse(response_headers['location']);
      http_host = uri.host
      http_port = uri.port
      http_path = uri.path
      http_path += '?'+uri.query if uri.query

      tries += 1
      if tries > 10
        raise "Too many redirects!"
      end
    else
      done = true
    end
  end

  # Thin doesn't like null bodies
  response_body = response.body || ''
  #::Rack::Utils::HeaderHash.new(response_headers)
  return [status.to_i, response_headers, response_body.to_s]
end

.ignore(*paths) ⇒ Object

Specified paths will be added to the ignore list, preventing matching files from appearing in the source tree



354
355
356
357
358
359
360
361
362
 
# File 'lib/gumdrop/site.rb', line 354

def ignore(*paths)
  paths.each do |path|
    if path.is_a? Array
      config.ignore.concat path
    else
      config.ignore << path
    end
  end      
end

.in_site_folder?(filename = "Gumdrop") ⇒ Boolean

Returns true if this, or a parent, folder has a Gumdrop file.

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/gumdrop/site.rb', line 348

def in_site_folder?(filename="Gumdrop")
  !fetch_site_file(filename).nil?
end

.init_logging ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/gumdrop/util/loggable.rb', line 32

def init_logging
  level= (site.config.log_level || :warn).to_sym
  @log = Logger.new site.config.log || STDOUT
  @log.level=  LOG_LEVELS[level]
  # @log.formatter = proc { |severity, datetime, progname, msg|
  #   # original_formatter.call(severity, datetime, progname, msg.dump)
  #   "#{msg}\n"
  # }
end

.log ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/gumdrop/util/loggable.rb', line 24

def log
  @log ||= begin
    log= Logger.new STDOUT
    log.level= LOG_LEVELS[:warn]
    log
  end
end

.mode ⇒ Object

Mostly for internal use, but you can update/change it in the configure block.



343
344
345
 
# File 'lib/gumdrop/site.rb', line 343

def mode
  site.mode
end

.no_render(*paths) ⇒ Object

Specified paths will be treated as binary files and copied, not rendered.



378
379
380
381
382
383
384
385
386
 
# File 'lib/gumdrop/site.rb', line 378

def no_render(*paths)
  paths.each do |path|
    if path.is_a? Array
      config.no_render.concat path
    else
      config.no_render << path
    end
  end      
end

.on(event_type, options = {}, &block) ⇒ Object

Listen for life-cycle events in your Gumdrop file like this:

Gumdrop.on :start do |event|
  puts "Here we go!"
end

Complete list of events fired by Gumdrop:

:start
:before_scan
:scan
:after_scan
:before_generate
:generate
:after_generate
:before_generate_item
:generate_item
:after_generate_item
:before_build
:build
:after_build
:before_checksum
:checksum
:after_checksum
:before_render
:render
:after_render
:before_render_item
:render_item
:after_render_item
:before_write
:write
:after_write
:before_copy_file
:copy_file
:after_copy_file
:before_write_file
:write_file
:after_write_file
:end

In the block parem ‘event` you will have access to :site, the current executing site instance, and :payload, where applicable.

:render_item is a special event because you can add/override the compiled output by modifying ‘event.data.return_value`



316
317
318
 
# File 'lib/gumdrop/site.rb', line 316

def on(event_type, options={}, &block)
  site.on event_type, options, &block
end

.prepare(&block) ⇒ Object 



326
327
328
 
# File 'lib/gumdrop/site.rb', line 326

def prepare(&block)
  site.prepare &block
end

.read_me ⇒ Object

Returns ‘ReadMe.md’ from gem package.



42
43
44
45
 
# File 'lib/gumdrop.rb', line 42

def self.read_me
  here= File.dirname(__FILE__)
  File.read here / ".." / "ReadMe.md"
end

.rebuild ⇒ Object 



150
151
152
153
 
# File 'lib/gumdrop/builder.rb', line 150

def rebuild
  site.scan true
  Builder.new.execute
end

.run(opts = {}) ⇒ Object

Kicks off the build process!



156
157
158
159
160
 
# File 'lib/gumdrop/builder.rb', line 156

def run(opts={})
  opts= opts.to_symbolized_hash
  site.options= opts
  Gumdrop.build opts
end

.site(opts = {}, force_new = false) ⇒ Object

This will look for a nearby Gumdrop file and load the Site the first time it is called. Each time after it will just return the already created Site.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/gumdrop/site.rb', line 254

def site(opts={}, force_new=false)
  opts= opts.to_symbolized_hash
  unless @current_site.nil? or force_new
    @current_site.options= opts unless opts.empty?
    @current_site
  else
    site_file= fetch_site_file
    unless site_file.nil?
      Site.new site_file, opts
    else
      nil
    end
  end
end

.view_helpers(&block) ⇒ Object 



79
80
81
 
# File 'lib/gumdrop/util/view_helpers.rb', line 79

def view_helpers(&block)
  Util::ViewHelpers.class_eval &block
end