halorgium-actionpack 3.0.pre

data/lib/action_view/helpers/javascript_helper.rb

@@ -0,0 +1,208 @@
+require 'action_view/helpers/tag_helper'
+require 'action_view/helpers/prototype_helper'
+
+module ActionView
+  module Helpers
+    # Provides functionality for working with JavaScript in your views.
+    #
+    # == Ajax, controls and visual effects
+    #
+    # * For information on using Ajax, see
+    #   ActionView::Helpers::PrototypeHelper.
+    # * For information on using controls and visual effects, see
+    #   ActionView::Helpers::ScriptaculousHelper.
+    #
+    # == Including the JavaScript libraries into your pages
+    #
+    # Rails includes the Prototype JavaScript framework and the Scriptaculous
+    # JavaScript controls and visual effects library.  If you wish to use
+    # these libraries and their helpers (ActionView::Helpers::PrototypeHelper
+    # and ActionView::Helpers::ScriptaculousHelper), you must do one of the
+    # following:
+    #
+    # * Use <tt><%= javascript_include_tag :defaults %></tt> in the HEAD
+    #   section of your page (recommended): This function will return
+    #   references to the JavaScript files created by the +rails+ command in
+    #   your <tt>public/javascripts</tt> directory. Using it is recommended as
+    #   the browser can then cache the libraries instead of fetching all the
+    #   functions anew on every request.
+    # * Use <tt><%= javascript_include_tag 'prototype' %></tt>: As above, but
+    #   will only include the Prototype core library, which means you are able
+    #   to use all basic AJAX functionality. For the Scriptaculous-based
+    #   JavaScript helpers, like visual effects, autocompletion, drag and drop
+    #   and so on, you should use the method described above.
+    #
+    # For documentation on +javascript_include_tag+ see
+    # ActionView::Helpers::AssetTagHelper.
+    module JavaScriptHelper
+      unless const_defined? :JAVASCRIPT_PATH
+        JAVASCRIPT_PATH = File.join(File.dirname(__FILE__), 'javascripts')
+      end
+
+      include PrototypeHelper
+
+      # Returns a link of the given +name+ that will trigger a JavaScript +function+ using the
+      # onclick handler and return false after the fact.
+      #
+      # The first argument +name+ is used as the link text.
+      #
+      # The next arguments are optional and may include the javascript function definition and a hash of html_options.
+      #
+      # The +function+ argument can be omitted in favor of an +update_page+
+      # block, which evaluates to a string when the template is rendered
+      # (instead of making an Ajax request first).
+      #
+      # The +html_options+ will accept a hash of html attributes for the link tag. Some examples are :class => "nav_button", :id => "articles_nav_button"
+      #
+      # Note: if you choose to specify the javascript function in a block, but would like to pass html_options, set the +function+ parameter to nil
+      #
+      #
+      # Examples:
+      #   link_to_function "Greeting", "alert('Hello world!')"
+      #     Produces:
+      #       <a onclick="alert('Hello world!'); return false;" href="#">Greeting</a>
+      #
+      #   link_to_function(image_tag("delete"), "if (confirm('Really?')) do_delete()")
+      #     Produces:
+      #       <a onclick="if (confirm('Really?')) do_delete(); return false;" href="#">
+      #         <img src="/images/delete.png?" alt="Delete"/>
+      #       </a>
+      #
+      #   link_to_function("Show me more", nil, :id => "more_link") do |page|
+      #     page[:details].visual_effect  :toggle_blind
+      #     page[:more_link].replace_html "Show me less"
+      #   end
+      #     Produces:
+      #       <a href="#" id="more_link" onclick="try {
+      #         $(&quot;details&quot;).visualEffect(&quot;toggle_blind&quot;);
+      #         $(&quot;more_link&quot;).update(&quot;Show me less&quot;);
+      #       }
+      #       catch (e) {
+      #         alert('RJS error:\n\n' + e.toString());
+      #         alert('$(\&quot;details\&quot;).visualEffect(\&quot;toggle_blind\&quot;);
+      #         \n$(\&quot;more_link\&quot;).update(\&quot;Show me less\&quot;);');
+      #         throw e
+      #       };
+      #       return false;">Show me more</a>
+      #
+      def link_to_function(name, *args, &block)
+        html_options = args.extract_options!.symbolize_keys
+
+        function = block_given? ? update_page(&block) : args[0] || ''
+        onclick = "#{"#{html_options[:onclick]}; " if html_options[:onclick]}#{function}; return false;"
+        href = html_options[:href] || '#'
+
+        content_tag(:a, name, html_options.merge(:href => href, :onclick => onclick))
+      end
+
+      # Returns a button with the given +name+ text that'll trigger a JavaScript +function+ using the
+      # onclick handler.
+      #
+      # The first argument +name+ is used as the button's value or display text.
+      #
+      # The next arguments are optional and may include the javascript function definition and a hash of html_options.
+      #
+      # The +function+ argument can be omitted in favor of an +update_page+
+      # block, which evaluates to a string when the template is rendered
+      # (instead of making an Ajax request first).
+      #
+      # The +html_options+ will accept a hash of html attributes for the link tag. Some examples are :class => "nav_button", :id => "articles_nav_button"
+      #
+      # Note: if you choose to specify the javascript function in a block, but would like to pass html_options, set the +function+ parameter to nil
+      #
+      # Examples:
+      #   button_to_function "Greeting", "alert('Hello world!')"
+      #   button_to_function "Delete", "if (confirm('Really?')) do_delete()"
+      #   button_to_function "Details" do |page|
+      #     page[:details].visual_effect :toggle_slide
+      #   end
+      #   button_to_function "Details", :class => "details_button" do |page|
+      #     page[:details].visual_effect :toggle_slide
+      #   end
+      def button_to_function(name, *args, &block)
+        html_options = args.extract_options!.symbolize_keys
+
+        function = block_given? ? update_page(&block) : args[0] || ''
+        onclick = "#{"#{html_options[:onclick]}; " if html_options[:onclick]}#{function};"
+
+        tag(:input, html_options.merge(:type => 'button', :value => name, :onclick => onclick))
+      end
+
+      JS_ESCAPE_MAP = {
+        '\\'    => '\\\\',
+        '</'    => '<\/',
+        "\r\n"  => '\n',
+        "\n"    => '\n',
+        "\r"    => '\n',
+        '"'     => '\\"',
+        "'"     => "\\'" }
+
+      # Escape carrier returns and single and double quotes for JavaScript segments.
+      def escape_javascript(javascript)
+        if javascript
+          javascript.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { JS_ESCAPE_MAP[$1] }
+        else
+          ''
+        end
+      end
+
+      # Returns a JavaScript tag with the +content+ inside. Example:
+      #   javascript_tag "alert('All is good')"
+      #
+      # Returns:
+      #   <script type="text/javascript">
+      #   //<![CDATA[
+      #   alert('All is good')
+      #   //]]>
+      #   </script>
+      #
+      # +html_options+ may be a hash of attributes for the <script> tag. Example:
+      #   javascript_tag "alert('All is good')", :defer => 'defer'
+      #   # => <script defer="defer" type="text/javascript">alert('All is good')</script>
+      #
+      # Instead of passing the content as an argument, you can also use a block
+      # in which case, you pass your +html_options+ as the first parameter.
+      #   <% javascript_tag :defer => 'defer' do -%>
+      #     alert('All is good')
+      #   <% end -%>
+      def javascript_tag(content_or_options_with_block = nil, html_options = {}, &block)
+        content =
+          if block_given?
+            html_options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
+            capture(&block)
+          else
+            content_or_options_with_block
+          end
+
+        tag = content_tag(:script, javascript_cdata_section(content), html_options.merge(:type => Mime::JS))
+
+        if block_called_from_erb?(block)
+          concat(tag)
+        else
+          tag
+        end
+      end
+
+      def javascript_cdata_section(content) #:nodoc:
+        "\n//#{cdata_section("\n#{content}\n//")}\n"
+      end
+
+    protected
+      def options_for_javascript(options)
+        if options.empty?
+          '{}'
+        else
+          "{#{options.keys.map { |k| "#{k}:#{options[k]}" }.sort.join(', ')}}"
+        end
+      end
+
+      def array_or_string_for_javascript(option)
+        if option.kind_of?(Array)
+          "['#{option.join('\',\'')}']"
+        elsif !option.nil?
+          "'#{option}'"
+        end
+      end
+    end
+  end
+end

data/lib/action_view/helpers/number_helper.rb

@@ -0,0 +1,311 @@
+require 'active_support/core_ext/big_decimal/conversions'
+require 'active_support/core_ext/float/rounding'
+
+module ActionView
+  module Helpers #:nodoc:
+    # Provides methods for converting numbers into formatted strings.
+    # Methods are provided for phone numbers, currency, percentage,
+    # precision, positional notation, and file size.
+    module NumberHelper
+      # Formats a +number+ into a US phone number (e.g., (555) 123-9876). You can customize the format
+      # in the +options+ hash.
+      #
+      # ==== Options
+      # * <tt>:area_code</tt>  - Adds parentheses around the area code.
+      # * <tt>:delimiter</tt>  - Specifies the delimiter to use (defaults to "-").
+      # * <tt>:extension</tt>  - Specifies an extension to add to the end of the
+      #   generated number.
+      # * <tt>:country_code</tt>  - Sets the country code for the phone number.
+      #
+      # ==== Examples
+      #  number_to_phone(5551234)                                           # => 555-1234
+      #  number_to_phone(1235551234)                                        # => 123-555-1234
+      #  number_to_phone(1235551234, :area_code => true)                    # => (123) 555-1234
+      #  number_to_phone(1235551234, :delimiter => " ")                     # => 123 555 1234
+      #  number_to_phone(1235551234, :area_code => true, :extension => 555) # => (123) 555-1234 x 555
+      #  number_to_phone(1235551234, :country_code => 1)                    # => +1-123-555-1234
+      #
+      #  number_to_phone(1235551234, :country_code => 1, :extension => 1343, :delimiter => ".")
+      #  => +1.123.555.1234 x 1343
+      def number_to_phone(number, options = {})
+        number       = number.to_s.strip unless number.nil?
+        options      = options.symbolize_keys
+        area_code    = options[:area_code] || nil
+        delimiter    = options[:delimiter] || "-"
+        extension    = options[:extension].to_s.strip || nil
+        country_code = options[:country_code] || nil
+
+        begin
+          str = ""
+          str << "+#{country_code}#{delimiter}" unless country_code.blank?
+          str << if area_code
+            number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4}$)/,"(\\1) \\2#{delimiter}\\3")
+          else
+            number.gsub!(/([0-9]{0,3})([0-9]{3})([0-9]{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
+            number.starts_with?('-') ? number.slice!(1..-1) : number
+          end
+          str << " x #{extension}" unless extension.blank?
+          str
+        rescue
+          number
+        end
+      end
+
+      # Formats a +number+ into a currency string (e.g., $13.65). You can customize the format
+      # in the +options+ hash.
+      #
+      # ==== Options
+      # * <tt>:precision</tt>  -  Sets the level of precision (defaults to 2).
+      # * <tt>:unit</tt>       - Sets the denomination of the currency (defaults to "$").
+      # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
+      # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to ",").
+      # * <tt>:format</tt>     - Sets the format of the output string (defaults to "%u%n"). The field types are:
+      #
+      #     %u  The currency unit
+      #     %n  The number
+      #
+      # ==== Examples
+      #  number_to_currency(1234567890.50)                    # => $1,234,567,890.50
+      #  number_to_currency(1234567890.506)                   # => $1,234,567,890.51
+      #  number_to_currency(1234567890.506, :precision => 3)  # => $1,234,567,890.506
+      #
+      #  number_to_currency(1234567890.50, :unit => "&pound;", :separator => ",", :delimiter => "")
+      #  # => &pound;1234567890,50
+      #  number_to_currency(1234567890.50, :unit => "&pound;", :separator => ",", :delimiter => "", :format => "%n %u")
+      #  # => 1234567890,50 &pound;
+      def number_to_currency(number, options = {})
+        options.symbolize_keys!
+
+        defaults  = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
+        currency  = I18n.translate(:'number.currency.format', :locale => options[:locale], :raise => true) rescue {}
+        defaults  = defaults.merge(currency)
+
+        precision = options[:precision] || defaults[:precision]
+        unit      = options[:unit]      || defaults[:unit]
+        separator = options[:separator] || defaults[:separator]
+        delimiter = options[:delimiter] || defaults[:delimiter]
+        format    = options[:format]    || defaults[:format]
+        separator = '' if precision == 0
+
+        begin
+          format.gsub(/%n/, number_with_precision(number,
+            :precision => precision,
+            :delimiter => delimiter,
+            :separator => separator)
+          ).gsub(/%u/, unit)
+        rescue
+          number
+        end
+      end
+
+      # Formats a +number+ as a percentage string (e.g., 65%). You can customize the
+      # format in the +options+ hash.
+      #
+      # ==== Options
+      # * <tt>:precision</tt>  - Sets the level of precision (defaults to 3).
+      # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
+      # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to "").
+      #
+      # ==== Examples
+      #  number_to_percentage(100)                                        # => 100.000%
+      #  number_to_percentage(100, :precision => 0)                       # => 100%
+      #  number_to_percentage(1000, :delimiter => '.', :separator => ',') # => 1.000,000%
+      #  number_to_percentage(302.24398923423, :precision => 5)           # => 302.24399%
+      def number_to_percentage(number, options = {})
+        options.symbolize_keys!
+
+        defaults   = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
+        percentage = I18n.translate(:'number.percentage.format', :locale => options[:locale], :raise => true) rescue {}
+        defaults  = defaults.merge(percentage)
+
+        precision = options[:precision] || defaults[:precision]
+        separator = options[:separator] || defaults[:separator]
+        delimiter = options[:delimiter] || defaults[:delimiter]
+
+        begin
+          number_with_precision(number,
+            :precision => precision,
+            :separator => separator,
+            :delimiter => delimiter) + "%"
+        rescue
+          number
+        end
+      end
+
+      # Formats a +number+ with grouped thousands using +delimiter+ (e.g., 12,324). You can
+      # customize the format in the +options+ hash.
+      #
+      # ==== Options
+      # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to ",").
+      # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
+      #
+      # ==== Examples
+      #  number_with_delimiter(12345678)                        # => 12,345,678
+      #  number_with_delimiter(12345678.05)                     # => 12,345,678.05
+      #  number_with_delimiter(12345678, :delimiter => ".")     # => 12.345.678
+      #  number_with_delimiter(12345678, :separator => ",")     # => 12,345,678
+      #  number_with_delimiter(98765432.98, :delimiter => " ", :separator => ",")
+      #  # => 98 765 432,98
+      #
+      # You can still use <tt>number_with_delimiter</tt> with the old API that accepts the
+      # +delimiter+ as its optional second and the +separator+ as its
+      # optional third parameter:
+      #  number_with_delimiter(12345678, " ")                     # => 12 345.678
+      #  number_with_delimiter(12345678.05, ".", ",")             # => 12.345.678,05
+      def number_with_delimiter(number, *args)
+        options = args.extract_options!
+        options.symbolize_keys!
+
+        defaults = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
+
+        unless args.empty?
+          ActiveSupport::Deprecation.warn('number_with_delimiter takes an option hash ' +
+            'instead of separate delimiter and precision arguments.', caller)
+          delimiter = args[0] || defaults[:delimiter]
+          separator = args[1] || defaults[:separator]
+        end
+
+        delimiter ||= (options[:delimiter] || defaults[:delimiter])
+        separator ||= (options[:separator] || defaults[:separator])
+
+        begin
+          parts = number.to_s.split('.')
+          parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+          parts.join(separator)
+        rescue
+          number
+        end
+      end
+
+      # Formats a +number+ with the specified level of <tt>:precision</tt> (e.g., 112.32 has a precision of 2).
+      # You can customize the format in the +options+ hash.
+      #
+      # ==== Options
+      # * <tt>:precision</tt>  - Sets the level of precision (defaults to 3).
+      # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
+      # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to "").
+      #
+      # ==== Examples
+      #  number_with_precision(111.2345)                    # => 111.235
+      #  number_with_precision(111.2345, :precision => 2)   # => 111.23
+      #  number_with_precision(13, :precision => 5)         # => 13.00000
+      #  number_with_precision(389.32314, :precision => 0)  # => 389
+      #  number_with_precision(1111.2345, :precision => 2, :separator => ',', :delimiter => '.')
+      #  # => 1.111,23
+      #
+      # You can still use <tt>number_with_precision</tt> with the old API that accepts the
+      # +precision+ as its optional second parameter:
+      #   number_with_precision(number_with_precision(111.2345, 2)   # => 111.23
+      def number_with_precision(number, *args)
+        options = args.extract_options!
+        options.symbolize_keys!
+
+        defaults           = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
+        precision_defaults = I18n.translate(:'number.precision.format', :locale => options[:locale],
+                                                                        :raise => true) rescue {}
+        defaults           = defaults.merge(precision_defaults)
+
+        unless args.empty?
+          ActiveSupport::Deprecation.warn('number_with_precision takes an option hash ' +
+            'instead of a separate precision argument.', caller)
+          precision = args[0] || defaults[:precision]
+        end
+
+        precision ||= (options[:precision] || defaults[:precision])
+        separator ||= (options[:separator] || defaults[:separator])
+        delimiter ||= (options[:delimiter] || defaults[:delimiter])
+
+        begin
+          rounded_number = BigDecimal.new((Float(number) * (10 ** precision)).to_s).round.to_f / 10 ** precision
+          number_with_delimiter("%01.#{precision}f" % rounded_number,
+            :separator => separator,
+            :delimiter => delimiter)
+        rescue
+          number
+        end
+      end
+
+      STORAGE_UNITS = [:byte, :kb, :mb, :gb, :tb].freeze
+
+      # Formats the bytes in +size+ into a more understandable representation
+      # (e.g., giving it 1500 yields 1.5 KB). This method is useful for
+      # reporting file sizes to users. This method returns nil if
+      # +size+ cannot be converted into a number. You can customize the
+      # format in the +options+ hash.
+      #
+      # ==== Options
+      # * <tt>:precision</tt>  - Sets the level of precision (defaults to 1).
+      # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
+      # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to "").
+      #
+      # ==== Examples
+      #  number_to_human_size(123)                                          # => 123 Bytes
+      #  number_to_human_size(1234)                                         # => 1.2 KB
+      #  number_to_human_size(12345)                                        # => 12.1 KB
+      #  number_to_human_size(1234567)                                      # => 1.2 MB
+      #  number_to_human_size(1234567890)                                   # => 1.1 GB
+      #  number_to_human_size(1234567890123)                                # => 1.1 TB
+      #  number_to_human_size(1234567, :precision => 2)                     # => 1.18 MB
+      #  number_to_human_size(483989, :precision => 0)                      # => 473 KB
+      #  number_to_human_size(1234567, :precision => 2, :separator => ',')  # => 1,18 MB
+      #
+      # Zeros after the decimal point are always stripped out, regardless of the
+      # specified precision:
+      #  helper.number_to_human_size(1234567890123, :precision => 5)        # => "1.12283 TB"
+      #  helper.number_to_human_size(524288000, :precision=>5)              # => "500 MB"
+      #
+      # You can still use <tt>number_to_human_size</tt> with the old API that accepts the
+      # +precision+ as its optional second parameter:
+      #  number_to_human_size(1234567, 2)    # => 1.18 MB
+      #  number_to_human_size(483989, 0)     # => 473 KB
+      def number_to_human_size(number, *args)
+        return nil if number.nil?
+
+        options = args.extract_options!
+        options.symbolize_keys!
+
+        defaults = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
+        human    = I18n.translate(:'number.human.format', :locale => options[:locale], :raise => true) rescue {}
+        defaults = defaults.merge(human)
+
+        unless args.empty?
+          ActiveSupport::Deprecation.warn('number_to_human_size takes an option hash ' +
+            'instead of a separate precision argument.', caller)
+          precision = args[0] || defaults[:precision]
+        end
+
+        precision ||= (options[:precision] || defaults[:precision])
+        separator ||= (options[:separator] || defaults[:separator])
+        delimiter ||= (options[:delimiter] || defaults[:delimiter])
+
+        storage_units_format = I18n.translate(:'number.human.storage_units.format', :locale => options[:locale], :raise => true)
+
+        if number.to_i < 1024
+          unit = I18n.translate(:'number.human.storage_units.units.byte', :locale => options[:locale], :count => number.to_i, :raise => true)
+          storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
+        else
+          max_exp  = STORAGE_UNITS.size - 1
+          number   = Float(number)
+          exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
+          exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
+          number  /= 1024 ** exponent
+
+          unit_key = STORAGE_UNITS[exponent]
+          unit = I18n.translate(:"number.human.storage_units.units.#{unit_key}", :locale => options[:locale], :count => number, :raise => true)
+
+          begin
+            escaped_separator = Regexp.escape(separator)
+            formatted_number = number_with_precision(number,
+              :precision => precision,
+              :separator => separator,
+              :delimiter => delimiter
+            ).sub(/(#{escaped_separator})(\d*[1-9])?0+\z/, '\1\2').sub(/#{escaped_separator}\z/, '')
+            storage_units_format.gsub(/%n/, formatted_number).gsub(/%u/, unit)
+          rescue
+            number
+          end
+        end
+      end
+    end
+  end
+end