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

• #bad_luck(path) ⇒ Object

  Fails.

• #data_for(template) ⇒ Object

  Loads and parses the YAML data from the data directory.

• #etags? ⇒ Boolean

  Shorthand to settings.etags == :on.

• #extract(text, length = 80) ⇒ Object

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

• #fetch(*args) ⇒ Object

  Replacemente for :try_haml, :try_slim, :sass & :coffee.

• #hash_for(name, type) ⇒ Object

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

• #link(text, length = 5) ⇒ Object

  Returns a url-friendly version of the given link, with a default maximum of 5 words.

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

  Sugar: formats a javascript

  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

  # 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

  # 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)

  # 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!..."
  

  # 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

  # 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

  # 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.

  # 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

  Sugar: formats a css stylesheet tag with the input

  # File 'lib/sinatra/piano.rb', line 46
  
  def style(path, more = '')
    "<link rel='stylesheet' type='text/css' href='#{path}' #{more} />"
  end
  

  Generated on Sat Sep 26 21:21:45 2026 by yard 0.9.45 (ruby-4.0.7).