Module: Sinatra::Piano

Defined in:
lib/sinatra/piano.rb

Overview

Piano was originally though as a Sinatra extension That’s why the code was defined here

Instance Method Summary collapse

Instance Method Details

#bad_luck(path) ⇒ Object

Fails. Shouts a 404 response and prints hints

If Piano is running in production mode, prints a plain 404 html or, if a 404.haml or 404.slim exists in the :views directory, returns it



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/sinatra/piano.rb', line 59

def bad_luck(path)
  content_type :html
  if settings.environment == :production
    if File.exists? "#{settings.views}/404.haml"
      @data = data_for "404"
      halt 404, haml(:"404")
    elsif File.exists? "#{settings.views}/404.slim"
      @data = data_for "404"
      halt 404, slim(:"404")
    else
      halt 404, '<h1>404 - Not Found</h1><p>Piano has found nothing in this address</p>'
    end
  else
    halt 404, "<h1>You have still to put something here.</h1><p>This is <em>#{path}</em></p><blockquote>Good luck!</blockquote>"
  end
end

#data_for(template) ⇒ Object

Loads and parses the YAML data from the data directory



40
41
42
43
 
# File 'lib/sinatra/piano.rb', line 40

def data_for(template)
  file_name = "#{settings.data}/#{template}.yaml"
  YAML.load_file(file_name) if File.exists?(file_name)
end

#etags? ⇒ Boolean

Shorthand to settings.etags == :on

Returns:

  • (Boolean) 


119
120
121
122
123
124
125
 
# File 'lib/sinatra/piano.rb', line 119

def etags?
  if settings.respond_to? :etags
    settings.etags == :on
  else
    true
  end
end

#extract(text, length = 80) ⇒ Object

Makes an extract out of the given text with the default length of 80 words

If an integer is passed as the second argument, the length of the result is adjusted properly:

extract "Hello World! Too much text is inconvenient", 2

returns

=> "Hello World!..."



94
95
96
97
98
 
# File 'lib/sinatra/piano.rb', line 94

def extract(text, length = 80)
  words = text.gsub(/<.+?>/, '').split
  return text if words.length <= length
  words[0..(length-1)].join(' ') + '...'
end

#fetch(*args) ⇒ Object

Replacemente for :try_haml, :try_slim, :sass & :coffee. Agnostic Work in progress



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/sinatra/piano.rb', line 9

def fetch(*args)
  resource = args.shift

  unless type = args.shift
    [:haml, :slim].each do |t|
      file_name = "#{settings.views}/#{resource}.#{t}"
      if File.exists?(file_name)
        type = t and break
      end
    end
  end

  return bad_luck("#{settings.views}/#{resource}.haml/slim") unless type

  if etags?
    if [:haml, :slim].include? type
      hash = hash_for resource, type
      if File.exists? "#{settings.views}/#{settings.data}/#{resource}.yaml"
        hash += hash_for "#{settings.data}/#{resource}", :yaml
      end

      etag hash
    else
      etag hash_for(resource, type)
    end
  end

  send type, resource.to_sym, *args # Send the template to Sinatra to take care of it
end

#hash_for(name, type) ⇒ Object

Builds a hash for a file within the :views directory Note: I feel like this functionality should be private



78
79
80
 
# File 'lib/sinatra/piano.rb', line 78

def hash_for(name, type)
  "#{name}.#{type} - #{File.mtime("#{settings.views}/#{name}.#{type}")}"
end

#link(text, length = 5) ⇒ Object

Returns a url-friendly version of the given link, with a default maximum of 5 words. ‘link` strips any non-letter or special character, downcases the string and replaces whitespace with “-” For example:

link "This is a special text! This won't be shown"

returns

=> "this-is-a-special-text"

You can specify a word length in the second argument.



113
114
115
116
 
# File 'lib/sinatra/piano.rb', line 113

def link(text, length = 5)
  words = text.gsub(/<.+?>/, '').gsub(' ', '-').downcase.gsub(/[^a-z0-9\-]/, '').split('-')
  words[0..(length-1)].join('-')
end

#script(path, more = '') ⇒ Object

Sugar: formats a javascript <script> tag with the input



51
52
53
 
# File 'lib/sinatra/piano.rb', line 51

def script(path, more = '')
  "<script type='text/javascript' src='#{path}' #{more} ></script>"
end

#style(path, more = '') ⇒ Object

Sugar: formats a css stylesheet <link /> tag with the input



46
47
48
 
# File 'lib/sinatra/piano.rb', line 46

def style(path, more = '')
  "<link rel='stylesheet' type='text/css' href='#{path}' #{more} />"
end