rocketeer 0.2.0 → 0.3.0

data/lib/rocketeer/helpers/form.rb

@@ -8,8 +8,22 @@
 # Please see the COPYING file for details.
 #
 
+#:nodoc:
 module Sinatra
+  #:nodoc:
   module FormHelper
+    ##
+    # Input field builder
+    #
+    # Useage:
+    #
+    #    input_field :my_field, :type => 'text'
+    #
+    # @param [Mixed] name    The name of the field
+    # @param [Hash]  options The fields options
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def input_field(name, options = {})
       if name.class == Array
         name = "#{name[0]}[#{name[1]}]"
@@ -28,38 +42,94 @@ module Sinatra
       "<input #{html_options.join(' ')}>"
     end
     
+    ##
+    # Text field builder
+    #
+    # Useage:
+    #    text_field :my_field, :class => 'text', :value => 'my value'
+    #
+    # @param [Mixed] name    The name of the field
+    # @param [Hash]  options The fields options
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def text_field(name, options = {})
       input_field name, options.merge({:type => 'text'})
     end
     
+    ##
+    # Password field builder
+    #
+    # Useage:
+    #    pasword_field :my_field, :class => 'text', :value => 'my value'
+    #
+    # @param [Mixed] name    The name of the field
+    # @param [Hash]  options The fields options
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def password_field(name, options = {})
       input_field name, options.merge({:type => 'password'})
     end
     
+    ##
+    # Email field builder
+    #
+    # Useage:
+    #    email_field :my_field, :class => 'text', :value => 'my value'
+    #
+    # @param [Mixed] name    The name of the field
+    # @param [Hash]  options The fields options
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def email_field(name, options = {})
       input_field name, options.merge({:type => 'email'})
     end
     
-    def select_box(name, options, selected = nil)
+    ##
+    # Select box builder
+    #
+    # Useage:
+    #    select_box :my_field, [['Hello', 1], ['World', 2]], 2 
+    #
+    # @param [Mixed] name     The name of the field
+    # @param [Array] rows     Array of the select field options
+    # @param [Mixed] selected Value of the selected option
+    # @author Jack Polgar
+    # @since 0.1
+    #
+    def select_box(name, rows, selected = nil)
       if name.class == Array
         name = "#{name[0]}[#{name[1]}]"
       end
       
       html = ["<select name=\"#{name.to_s}\" id=\"#{name.to_s}\">"]
       
-      options.each do |option|
-        if option[1] == selected
+      rows.each do |row|
+        if row[1] == selected
           selected_html = ' selected'
         else
           selected_html = ''
         end
-        html.push "  <option value=\"#{option[1]}\" #{selected_html}>#{option[0]}</option>"
+        html.push "  <option value=\"#{row[1]}\" #{selected_html}>#{row[0]}</option>"
       end
       
       html.push "</select>\n"
       return html.join("\n")
     end
     
+    ##
+    # Text area builder
+    #
+    # Useage:
+    #    textarea :my_field, :class => 'text', :value => 'my value'
+    #
+    # @param [Mixed] name    The name of the field
+    # @param [Hash]  options The fields options
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def textarea(name, options = {})
       if name.class == Array
         name = "#{name[0]}[#{name[1]}]"

data/lib/rocketeer/helpers/html.rb

@@ -8,8 +8,23 @@
 # Please see the COPYING file for details.
 #
 
+#:nodoc:
 module Sinatra
+  #:nodoc:
   module HTMLHelper
+    ##
+    # Creates a link to the specified URL with the specified text
+    #
+    # Useage:
+    #
+    #    link_to 'Google', 'http://google.com.au'
+    #
+    # @param [String] text The text for the link
+    # @param [String] the_url The URL to link to
+    # @param [Hash] options Options for the link
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def link_to(text, the_url, options = {})
       options = options.merge({
         :href => the_url ? url(the_url) : request.path_info
@@ -25,12 +40,26 @@ module Sinatra
       
       html_options = []
       options.each do |k, v|
+        pass if v === nil
         html_options.push "#{k.to_s}=\"#{v.to_s}\""
       end
       
       "<a #{html_options.join(' ')}>#{text}</a>"
     end
     
+    ##
+    # Creates a link to the specified URL unless the request matches the URL.
+    #
+    # Useage:
+    #
+    #    link_to_unless_current 'Google', 'http://google.com.au'
+    #
+    # @param [String] text The text for the link
+    # @param [String] the_url The URL to link to
+    # @param [Hash] options Options for the link
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def link_to_unless_current(text, the_url, options = {})
       if request.path_info == the_url
         text
@@ -39,10 +68,56 @@ module Sinatra
       end
     end
     
+    ##
+    # Creates a link to the specified URL if the condition is met.
+    #
+    # Useage:
+    #
+    #    link_to 'Google', 'http://google.com.au'
+    #
+    # @param [Boolean] condition The condition to check
+    # @param [String] text The text for the link
+    # @param [String] the_url The URL to link to
+    # @param [Hash] options Options for the link
+    # @author Jack Polgar
+    # @since 0.3
+    #
+    def link_to_if(condition, text, the_url, options = {})
+      if condition
+        link_to text, the_url, options = {}
+      else
+        text
+      end
+    end
+    
+    ##
+    # Returns the code for linking CSS style sheets.
+    #
+    # Useage:
+    #
+    #    css_inc_tag '/assets/css/master.css'
+    #    css_inc_tag '/assets/css/print', 'screen'
+    #
+    # @param [String] url The URL of the stylesheet
+    # @param [String] media The media of the stylesheet
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def css_inc_tag(url, media = "screen")
       "<link rel=\"stylesheet\" href=\"#{url}?#{Time.now.to_i}\" media=\"#{media}\" />"
     end
     
+    ##
+    # Returns the code for linking javascript files.
+    #
+    # Useage:
+    #
+    #    js_inc_tag '/assets/js/app.js'
+    #
+    # @param [String] url The URL of the file
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def js_inc_tag(url)
       "<script src=\"#{url}\" type=\"text/javascript\"></script>"
     end

data/lib/rocketeer/helpers/text.rb

@@ -8,16 +8,44 @@
 # Please see the COPYING file for details.
 #
 
+#:nodoc:
 module Sinatra
+  #:nodoc:
   module TextHelper
+    ##
+    # Pluralizes the string.
+    #
+    # Useage:
+    #
+    #    pluralize comments.count, 'comment'
+    #
+    # @param [Integer] count The count
+    # @param [String] singular The singular form of the string
+    # @param [String] plural The plural form of the word
+    # @author Jack Polgar
+    # @since 0.1
+    #
     def pluralize(count, singular, plural = nil)
       "#{count || 0} " + ((count == 1 || count =~ /^1(\.0+)?$/) ? singular : (plural || singular.pluralize))
     end
     
-    def short_text(text, length = 30, truncate_string = "...")
+    ##
+    # Shortens the string to the specified length
+    #
+    # Useage:
+    #
+    #    shorten_string 'A very, very, long string', 5
+    #
+    # @param [String] text The string to shorten
+    # @param [Integer] length The length to shorten to
+    # @param [String] truncate_string Text to place at the end of the shortened string
+    # @author Jack Polgar
+    # @since 0.1
+    #
+    def shorten_string(text, length = 30, truncate_string = "...")
       return if text.nil?
-      l = length - truncate_string.mb_chars.length
-      text.mb_chars.length > length ? text[/\A.{#{l}}\w*\;?/m][/.*[\w\;]/m] + truncate_string : text
+      l = length - truncate_string.length
+      text.length > length ? text[/\A.{#{l}}\w*\;?/m][/.*[\w\;]/m] + truncate_string : text
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketeer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-23 00:00:00.000000000 +10:00
-default_executable: 
+date: 2011-07-23 00:00:00.000000000Z
 dependencies: []
-description: Helpers for Sinatra
+description: Rocketeer is a collection of helpers for the Sinatra framework.
 email: xocide@gmail.com
 executables: []
 extensions: []
@@ -23,7 +22,6 @@ files:
 - lib/rocketeer/helpers/html.rb
 - lib/rocketeer/helpers/form.rb
 - lib/rocketeer/helpers/text.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/rocketeer
 licenses: []
 post_install_message: 
@@ -44,8 +42,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Rocketeer
+summary: A collection of helpers for Sinatra
 test_files: []