sinatra-support 1.0.1

data/lib/sinatra/support/htmlhelpers.rb

@@ -0,0 +1,78 @@
+# Useful HTML helpers.
+#
+#   require 'sinatra/support/htmlhelpers'
+#
+#   class Main < Sinatra::Base
+#     helpers Sinatra::HtmlHelpers
+#   end
+#
+# == Helpers
+#
+# This provides the following helpers:
+#
+# === {#h h} - Escapes HTML output
+#   <a href="<%= h url %>">
+#
+# === {#tag tag} - Builds HTML tags
+#   tag :a                     #=> "<a>"
+#   tag :strong, "Yes"         #=> "<strong>Yes</strong>"
+#   tag :a, "OK", href: "#"    #=> "<a href='#'>OK</a>"
+#
+module Sinatra::HtmlHelpers
+  # Returns an HTML sanitized string.
+  def h(str)
+    Rack::Utils.escape_html(str)
+  end
+
+  # Accepts a list of pairs and produces option tags.
+  #
+  # @example
+  #
+  #   select_options([['One', 1], ['Two', 2]])
+  #   select_options([['One', 1], ['Two', 2]], 1)
+  #   select_options([['One', 1], ['Two', 2]], 1, '- Choose -')
+  #
+  #   # using it with the provided date helpers...
+  #   select_options year_choices, 2010 # select 2010 as default
+  #   select_options month_choices, 5 # select May as default
+  #   select_options day_choices, 25 # select the 25th as default
+  #
+  # @param [Array] pairs a collection of label, value tuples.
+  # @param [Object] current the current value of this select.
+  # @param [#to_s] prompt a default prompt to place at the beginning
+  #                of the list.
+  def select_options(pairs, current = nil, prompt = nil)
+    pairs.unshift([prompt, '']) if prompt
+
+    pairs.map { |label, value|
+      tag(:option, label, :value => value, :selected => (current == value))
+    }.join("\n")
+  end
+
+  # Builds a tag.
+  def tag(tag, content, atts = {})
+    if self_closing?(tag)
+      %(<#{ tag }#{ tag_attributes(atts) } />)
+    else
+      %(<#{ tag }#{ tag_attributes(atts) }>#{h content}</#{ tag }>)
+    end
+  end
+
+  def tag_attributes(atts = {})
+    atts.inject([]) { |a, (k, v)| 
+      a << (' %s="%s"' % [k, escape_attr(v)]) if v
+      a
+    }.join('')
+  end
+
+  def escape_attr(str)
+    str.to_s.gsub("'", "&#39;").gsub('"', "&quot;")
+  end
+
+  def self_closing?(tag)
+    @self_closing ||= [:area, :base, :basefont, :br, :hr,
+                       :input, :img, :link, :meta]
+
+    @self_closing.include?(tag.to_sym)
+  end
+end

data/lib/sinatra/support/i18nsupport.rb

@@ -0,0 +1,118 @@
+# I18n support.
+#
+#   require 'sinatra/support/i18nsupport'
+#
+#   class Main < Sinatra::Base
+#     register Sinatra::I18nSupport
+#     load_locales './config/locales'
+#     set :default_locale, 'fr'  # Optional; defaults to 'en'
+#   end
+#
+# Be sure that you have the +I18n+ gem.
+#
+#   # Gemfile
+#   gem "i18n"
+#
+# (or +gem install i18n+)
+#
+# Then put your locale YAML files into +./config/locales+ (whatever path you
+# use for {#load_locales}:
+#
+#   # config/locales/en.yml
+#   en:
+#     an_article: "An article"
+#
+# == Helpers
+#
+# === {Helpers#t t} - Translates something.
+#
+#   <h3><%= t('article.an_article') %></h3>
+#   <h5><%= t('article.delete', name: @article.to_s) %></h5>
+#
+# === {Helpers#t l} - Localizes something.
+#
+#   <%= l(Time.now) %>
+#   <%= l(Time.now, format: :short) %>
+#
+# === {Helpers#current_locale current_locale} - Returns the current locale name.
+#
+#   <script>
+#     window.locale = <%= current_locale.inspect %>;
+#   </script>
+#
+# === {Helpers#available_locales available_locales} - A list of available locales.
+#
+#   <% if available_locales.include?(:es) %>
+#     <a href="/locales/es">en Espanol</a>
+#   <% end %>
+#
+# == Changing locales
+#
+# Set +session[:locale]+ to the locale name.
+#
+#   get '/locales/:locale' do |locale|
+#     not_found  unless locales.include?(locale)
+#     session[:locale] = locale
+#   end
+#
+# If you want to override the way of checking for the current locale,
+# simply redefine the `current_locale` helper:
+#
+#   helpers do
+#     def current_locale
+#       current_user.locale || session[:locale] || settings.default_locale
+#     end
+#   end
+#
+# == Locale files
+#
+# This gem does not ship with default options for time, date and such.
+# You may want to get those from:
+#
+#   https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale
+# 
+# == Using a different backend
+#
+# Instead of calling {#load_locales}, just load the right I18n backend
+# using the I18n gem.
+#
+# You can also just use I18n.store_translations if you still want to use
+# the default simple I18n backend.
+#
+# == Settings
+#
+# [+default_locale+]    The locale to use by default. Defaults to +"en"+.
+#
+module Sinatra::I18nSupport
+  def self.registered(app)
+    require 'i18n'
+    app.set :default_locale, 'en'
+    app.helpers Helpers
+  end
+
+  # Loads the locales in the given path.
+  def load_locales(path)
+    Dir[File.join(path, '*.yml')].each do |file|
+      I18n.backend.load_translations file
+    end
+  end
+
+  module Helpers
+    # Override this if you need to, say, check for the user's preferred locale.
+    def current_locale
+      session[:locale] || settings.default_locale
+    end
+
+    def available_locales
+      I18n.available_locales
+    end
+
+    def l(what, options={})
+      I18n.l what, {:locale => current_locale}.merge(options)
+    end
+
+    def t(what, options={})
+      I18n.t what, {:locale => current_locale}.merge(options)
+    end
+  end
+end

data/lib/sinatra/support/ifhelpers.rb

@@ -0,0 +1,63 @@
+# Useful HAML condition helpers.
+#
+#   require 'sinatra/support/htmlhelpers'
+#
+#   class Main < Sinatra::Base
+#     helpers Sinatra::IfHelpers
+#   end
+#
+# == Helpers
+#
+# These are helpers you can use in HAML files.
+#
+# === {#active_if active_if} - Adds +class=active+ if a condition passes.
+#
+#   - @users.each do |user|
+#     %li{active_if(user == current_user)}
+#       = user.to_s
+#
+# === {#checked_if checked_if} - Adds +checked=1+.
+#
+#   %input{checked_if(page.available?), type: 'checkbox'}
+#
+# === {#hide_if hide_if} - Adds +style=display:none+.
+#
+#   %div#comments{hide_if(post.comments.empty?)}
+#
+# === {#show_if show_if} - Inverse of +hide_if+.
+#
+# === {#selected_if selected_if} - Adds +selected=1+.
+#
+# === {#disabled_if disabled_if} - Adds +disabled=1+.
+#
+# === {#enabled_if enabled_if} - Inverse of +disabled_if+.
+#
+module Sinatra::IfHelpers
+  def active_if(condition)
+    condition ? {:class => 'active'} : {}
+  end
+
+  def checked_if(condition)
+    condition ? {:checked => '1'} : {}
+  end
+
+  def selected_if(condition)
+    condition ? {:selected => '1'} : {}
+  end
+
+  def disabled_if(condition)
+    condition ? {:disabled => '1'} : {}
+  end
+
+  def enabled_if(condition)
+    disabled_if !condition
+  end
+
+  def hide_if(condition)
+    condition ? {:style => 'display:none'} : {}
+  end
+
+  def show_if(condition)
+    hide_if !condition
+  end
+end

data/lib/sinatra/support/jssupport.rb

@@ -0,0 +1,50 @@
+# Adds a route for JavaScript files.
+#
+# == Usage
+#
+#   require 'sinatra/support/jssupport'
+#
+# Use {#serve_js} in the Sinatra DSL to serve up files.
+#
+#   register Sinatra::JsSupport
+#   serve_js '/js', from: './app/js'
+#
+# Assuming you have a +app/js/jquery.js+ file, you will
+# then be able to access it from the given URL prefix.
+#
+#   $ curl "http://localhost:4567/js/jquery.js"
+#
+# This plugin supports CoffeeScript. To use it, simply
+# add a CoffeeScript file in the JS file path.
+#
+#   # Will first try app/js/application.coffee,
+#   # then move onto app/js/application.js if it's not found.
+#
+#   $ curl "http://localhost:4567/js/application.js"
+#
+# To use CoffeeScript, you will need the +coffee_script+ gem.
+#
+module Sinatra::JsSupport
+  def self.registered(app)
+    app.set :js_max_age, app.development? ? 0 : 86400*30
+  end
+
+  def serve_js(url_prefix, options={})
+    path   = File.join(url_prefix, '*.js')
+    prefix = options[:from]
+
+    get path do |name|
+      fname = Dir[File.join(prefix, "#{name}.{js,coffee}")].first  or pass
+
+      content_type :js
+      last_modified File.mtime(fname)
+      cache_control :public, :must_revalidate, :max_age => settings.js_max_age
+
+      if fname =~ /\.coffee$/
+        coffee File.read(fname)
+      else
+        send_file fname
+      end
+    end
+  end
+end

data/lib/sinatra/support/numeric.rb

@@ -0,0 +1,105 @@
+# Provides numeric helpers.
+#
+#   require 'sinatra/support/numeric'
+#
+#   class Main < Sinatra::Base
+#     register Sinatra::Numeric
+#   end
+#
+# == Helpers
+#
+# This plugin provides the following helpers:
+#
+# === {Helpers#currency currency} - Formats a string as a currency.
+#
+#   <%= currency(100) %>
+#   <!-- $100 -->
+#
+# == {Helpers#percentage percentage} - Formats a number as a percentage.
+#
+#   <%= percentage(100) %>
+#   <!-- 100.00% -->
+#
+# == Settings
+#
+# You may change the settings like so:
+#
+#   Main.configure do |m|
+#     m.set :default_currency_unit, '$'
+#     m.set :default_currency_precision, 2
+#     m.set :default_currency_separator, ','
+#   end
+#
+module Sinatra::Numeric
+  def self.registered(app)
+    app.set :default_currency_unit, '$'
+    app.set :default_currency_precision, 2
+    app.set :default_currency_separator, ','
+
+    app.helpers Helpers
+  end
+
+  module Helpers
+    # Formats a number into a currency display. Uses the following settings:
+    #
+    # - settings.default_currency_unit      (defaults to '$')
+    # - settings.default_currency_precision (defaults to 2)
+    # - settings.default_currenty_separator (defaults to ',')
+    #
+    # @example
+    #
+    #   currency(100) == "$ 100.00"
+    #   # => true
+    #
+    #   currency(100, :unit => "&pound;") == "&pound; 100.00"
+    #   # => true
+    #
+    #   currency(100, :precision => 0) == "$ 100"
+    #   => # true
+    #
+    #   # somewhere in your sinatra context after registering Sinatra::Support
+    #   set :default_currency_unit, '&pound;'
+    #   set :default_currency_precision, 3
+    #   set :default_currency_separator, ' '
+    #
+    #   currency(100) == "&pound; 100.000"
+    #   # => true
+    #
+    # @param [Numeric] number the number you wish to display as a currency.
+    # @param [Hash] opts the various options available.
+    # @option opts [#to_s] :unit (defaults to '$')
+    # @option opts [Fixnum] :precision (defaults to 2)
+    # @option opts [#to_s] :separator (defaults to ',')
+    # @return [String] the formatted string based on `number`.
+    # @return [nil] if given nil or an empty string.
+    def currency(number, opts = {})
+      return if number.to_s.empty?
+
+      unit      = opts[:unit]      || settings.default_currency_unit
+      precision = opts[:precision] || settings.default_currency_precision
+      separator = opts[:separator] || settings.default_currency_separator
+
+      ret = "%s %.#{ Integer(precision) }f" % [unit, number]
+      parts = ret.split('.')
+      parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{separator}")
+      parts.join('.')
+    end
+
+    # Show the percentage representation of a numeric value.
+    #
+    # @example
+    #   percentage(100) == "100.00%"
+    #   percentage(100, 0) == "100%"
+    #
+    # @param [Numeric] number A numeric value
+    # @param [Fixnum]  precision (defaults to 2) Number of decimals to show.
+    # @return [String] the number displayed as a percentage
+    # @return [nil]    given a nil value or an empty string.
+    def percentage(number, precision = 2)
+      return if number.to_s.empty?
+
+      ret = "%02.#{ precision }f%" % number
+      ret.gsub(/\.0*%$/, '%')
+    end
+  end
+end

data/lib/sinatra/support/ohmerrorhelpers.rb

@@ -0,0 +1,75 @@
+# Ohm error helpers.
+#
+#   # Only for those who use Ohm and HAML.
+#   require 'ohm'
+#   require 'haml'
+#
+#   require 'sinatra/support/ohmerrorhelpers'
+#
+#   class Main < Sinatra::Base
+#     helpers Sinatra::OhmErrorHelpers
+#   end
+#
+# == Common usage
+# 
+#   - errors_on @user do |e|
+#     - e.on [:email, :not_present], "We need your email address."
+#     - e.on [:password, :not_present], "You must specify a password."
+#
+# This produces the following:
+#
+#   <div class="errors">
+#     <ul>
+#       <li>We need your email address</li>
+#       <li>You must specify a password.</li>
+#     </ul>
+#   </div>
+#
+module Sinatra::OhmErrorHelpers
+  # Presents errors on your form. Takes the explicit approach and assumes
+  # that for every form you have, the copy for the errors are important,
+  # instead of producing canned responses.
+  #
+  # @param [#errors] object An object responding to #errors. This validation
+  #                  also checks for the presence of a #full_messages method
+  #                  in the errors object for compatibility with 
+  #                  ActiveRecord style objects.
+  # @param [Hash] options a hash of HTML attributes to place on the
+  #               containing div.
+  # @option options [#to_s] :class (defaults to errors) The css class to put 
+  #                                in the div.
+  #
+  # @yield [Sinatra::Support::HamlErrorPresenter] an object responding to #on.
+  #
+  def errors_on(object, options = { :class => 'errors' }, &block)
+    return if object.errors.empty?
+
+    lines = if object.errors.respond_to?(:full_messages)
+      object.errors.full_messages
+    else
+      HamlErrorPresenter.new(object.errors).present(self, &block)
+    end
+
+    haml_tag(:div, options) do
+      haml_tag(:ul) do
+        lines.each do |error|
+          haml_tag(:li, error)
+        end
+      end
+    end
+  end
+
+  # @see http://github.com/citrusbyte/reddit-clone
+  class HamlErrorPresenter < Ohm::Validations::Presenter
+    def on(error, message = (block_given? ? @context.capture_haml { yield } : raise(ArgumentError)))
+      handle(error) do
+        @output << message
+      end
+    end
+
+    def present(context)
+      @context = context
+      super()
+    end
+  end
+end

data/lib/sinatra/support/version.rb

@@ -0,0 +1,9 @@
+module Sinatra
+  module Support
+    VERSION = "1.0.1"
+
+    def self.version
+      VERSION
+    end
+  end
+end

data/lib/sinatra/support.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../support/version', __FILE__)
+
+module Sinatra
+  autoload :Country,         File.expand_path('../support/country', __FILE__)
+  autoload :CountryHelpers,  File.expand_path('../support/countryhelpers', __FILE__)
+  autoload :CssSupport,      File.expand_path('../support/csssupport', __FILE__)
+  autoload :DateForms,       File.expand_path('../support/dateforms', __FILE__)
+  autoload :HtmlHelpers,     File.expand_path('../support/htmlhelpers', __FILE__)
+  autoload :JsSupport,       File.expand_path('../support/jssupport', __FILE__)
+  autoload :OhmErrorHelpers, File.expand_path('../support/ohmerrorhelpers', __FILE__)
+  autoload :Numeric,         File.expand_path('../support/numeric', __FILE__)
+  autoload :IfHelpers,       File.expand_path('../support/ifhelpers', __FILE__)
+  autoload :I18nSupport,     File.expand_path('../support/i18nsupport', __FILE__)
+
+  module Support
+  end
+end

data/test/fixtures/i18n/en.yml

@@ -0,0 +1,15 @@
+en:
+  article:
+    new: "New Article"
+
+  time:
+    formats:
+      default: %a, %d. %b %Y %H:%M:%S %z
+      short: %d. %b %H:%M
+      am: "am"
+      pm: "pm"
+
+  date:
+    abbr_day_names: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+    abbr_month_names: [~, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
+      

data/test/fixtures/i18n/tl.yml

@@ -0,0 +1,15 @@
+tl:
+  article:
+    new: "Bagong Artikulo"
+
+  time:
+    formats:
+      default: %a, %d. %b %Y %H:%M:%S %z
+      short: %d. %b %H:%M
+      am: "am"
+      pm: "pm"
+
+  date:
+    abbr_day_names: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+    abbr_month_names: [~, Ene, Peb, Mar, Abr, May, Hun, Hul, Aug, Set, Okt, Nob, Des]
+      

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'  unless RUBY_VERSION >= '1.9'
+require 'test/unit'
+require 'contest'
+require 'ohm'
+require 'haml'
+require 'mocha'
+require 'rack/test'
+require 'nokogiri'
+require 'sinatra'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+$:.unshift File.dirname(__FILE__)
+
+require 'sinatra/support'
+
+class Test::Unit::TestCase
+  def settings
+    @app ||= Sinatra::Application.new
+  end
+
+  def self.fixture_path(*a)
+    root = File.expand_path('../fixtures', __FILE__)
+    File.join root, a
+  end
+
+  def fixture_path(*a)
+    self.class.fixture_path *a
+  end
+end

data/test/test_country.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../helper', __FILE__)
+
+class CountryTest < Test::Unit::TestCase
+  include Sinatra::CountryHelpers
+
+  Country = Sinatra::Country
+
+  test "country_choices returns Country.to_select" do
+    assert_equal Country.to_select, country_choices  
+  end
+
+  test "241 countries" do
+    assert_equal 246, Country.to_select.length  
+  end
+
+  test "has a matching name for all keys" do
+    Country.all.each do |code, name|
+      assert_equal name, Country[code]
+      assert_equal name, Country[code.to_s]
+    end
+  end
+
+  test "random returns a valid code" do
+    246.times {
+      assert Country[Country.random]
+    }
+  end
+
+  test "finding a country with wrong parameters" do
+    assert_nil Country[""]
+    assert_nil Country[nil]
+    assert_nil Country[:XX]
+    assert_nil Country["XX"]
+  end
+end