rocketeer 0.3.0 → 0.4.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+*.gem

data/COPYING

@@ -1,4 +1,4 @@
-Copyright (c) 2011, Jack Polgar
+Copyright (c) 2011-2012, Jack Polgar
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rocketeer.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rocketeer.rb

@@ -12,4 +12,11 @@ require 'sinatra/base'
 
 require 'rocketeer/helpers/html'
 require 'rocketeer/helpers/form'
-require 'rocketeer/helpers/text'
+require 'rocketeer/helpers/text'
+
+# @private
+module Sinatra
+  helpers Rocketeer::Helpers::HTML
+  helpers Rocketeer::Helpers::Form
+  helpers Rocketeer::Helpers::Text
+end

data/lib/rocketeer/helpers/form.rb

@@ -8,153 +8,151 @@
 # 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]}]"
+module Rocketeer
+  module Helpers
+    module Form
+      ##
+      # 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]}]"
+        end
+        defaults = {
+          :id => name.to_s,
+          :name => name.to_s
+        }
+        
+        html_options = []
+        options = defaults.merge(options)
+        options.each do |k, v|
+          html_options.push "#{k}=\"#{v}\""
+        end
+        
+        "<input #{html_options.join(' ')}>"
       end
-      defaults = {
-        :id => name.to_s,
-        :name => name.to_s
-      }
       
-      html_options = []
-      options = defaults.merge(options)
-      options.each do |k, v|
-        html_options.push "#{k}=\"#{v}\""
+      ##
+      # 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
       
-      "<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
-    
-    ##
-    # 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]}]"
+      ##
+      # 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
       
-      html = ["<select name=\"#{name.to_s}\" id=\"#{name.to_s}\">"]
-      
-      rows.each do |row|
-        if row[1] == selected
-          selected_html = ' selected'
-        else
-          selected_html = ''
-        end
-        html.push "  <option value=\"#{row[1]}\" #{selected_html}>#{row[0]}</option>"
+      ##
+      # 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
       
-      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]}]"
-      end
-      defaults = {
-        :id => name.to_s,
-        :name => name.to_s
-      }
-      if options[:value]
-        value = options[:value]
-        options[:value] = nil
-      else
-        value = ''
+      ##
+      # 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}\">"]
+        
+        rows.each do |row|
+          if row[1] == selected
+            selected_html = ' selected'
+          else
+            selected_html = ''
+          end
+          html.push "  <option value=\"#{row[1]}\" #{selected_html}>#{row[0]}</option>"
+        end
+        
+        html.push "</select>\n"
+        return html.join("\n")
       end
       
-      html_options = []
-      options = defaults.merge(options)
-      options.each do |k, v|
-        next if v == nil
-        html_options.push "#{k}=\"#{v}\""
+      ##
+      # 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]}]"
+        end
+        defaults = {
+          :id => name.to_s,
+          :name => name.to_s
+        }
+        if options[:value]
+          value = options[:value]
+          options[:value] = nil
+        else
+          value = ''
+        end
+        
+        html_options = []
+        options = defaults.merge(options)
+        options.each do |k, v|
+          next if v == nil
+          html_options.push "#{k}=\"#{v}\""
+        end
+        
+        "<textarea #{html_options.join(' ')}>#{value}</textarea>"
       end
-      
-      "<textarea #{html_options.join(' ')}>#{value}</textarea>"
     end
   end
-  
-  helpers FormHelper
 end

data/lib/rocketeer/helpers/html.rb

@@ -8,120 +8,118 @@
 # 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
-      })
-      if options[:confirm]
-        options[:"data-confirm"] = options[:confirm]
-        options[:confirm] = nil
+module Rocketeer
+  module Helpers
+    module HTML
+      ##
+      # 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, url, options = {})
+        options = options.merge({
+          :href => url ? url : request.path_info
+        })
+        if options[:confirm]
+          options[:"data-confirm"] = options[:confirm]
+          options[:confirm] = nil
+        end
+        if options[:remote]
+          options[:"data-remote"] = options[:remote]
+          options[:remote] = nil
+        end
+        
+        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
-      if options[:remote]
-        options[:"data-remote"] = options[:remote]
-        options[:remote] = nil
+      
+      ##
+      # 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, url, options = {})
+        if request.path_info == url
+          text
+        else
+          link_to text, url, options
+        end
       end
       
-      html_options = []
-      options.each do |k, v|
-        pass if v === nil
-        html_options.push "#{k.to_s}=\"#{v.to_s}\""
+      ##
+      # Creates a link to the specified URL if the condition is met.
+      #
+      # Useage:
+      #
+      #    link_to_if Time.now.year == 2011, '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, url, options = {})
+        if condition
+          link_to text, url, options = {}
+        else
+          text
+        end
       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
-      else
-        link_to text, the_url, options
+      ##
+      # Returns the code for linking CSS style sheets.
+      #
+      # Useage:
+      #
+      #    css_inc_tag '/assets/css/master.css'
+      #    css_inc_tag '/assets/css/print.css', '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_link_tag(url, media = "screen")
+        "<link rel=\"stylesheet\" href=\"#{url}?#{Time.now.to_i}\" media=\"#{media}\" />"
       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
+      
+      ##
+      # 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
     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
   end
-
-  helpers HTMLHelper
 end

data/lib/rocketeer/helpers/text.rb

@@ -8,46 +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
-    
-    ##
-    # 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.length
-      text.length > length ? text[/\A.{#{l}}\w*\;?/m][/.*[\w\;]/m] + truncate_string : text
+module Rocketeer
+  module Helpers
+    module Text
+      ##
+      # 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
+      
+      ##
+      # 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.length
+        text.length > length ? text[/\A.{#{l}}\w*\;?/m][/.*[\w\;]/m] + truncate_string : text
+      end
     end
   end
-  
-  helpers TextHelper
 end

data/lib/rocketeer/version.rb

@@ -0,0 +1,13 @@
+#
+# Rocketeer
+# Copyright (C) 2011-2012 Jack Polgar
+# All Rights Reserved
+# http://github.com/nirix/rockets
+#
+# Relased under the BSD 3-clause / New BSD License
+# Please see the COPYING file for details.
+#
+
+module Rocketeer
+  VERSION = "0.4.0"
+end

data/rocketeer.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rocketeer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "rocketeer"
+  gem.version       = Rocketeer::VERSION
+  gem.authors       = ["Jack Polgar"]
+  gem.email         = ["nrx@nirix.net"]
+  gem.summary       = "A collection of helpers for Sinatra."
+  gem.description   = "Rocketeer is a collection of helpers for the Sinatra framework."
+  gem.homepage      = "https://github.com/nirix/rockets"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketeer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,20 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-23 00:00:00.000000000Z
+date: 2012-04-26 00:00:00.000000000 Z
 dependencies: []
 description: Rocketeer is a collection of helpers for the Sinatra framework.
-email: xocide@gmail.com
+email:
+- nrx@nirix.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - COPYING
+- Gemfile
+- Rakefile
 - lib/rocketeer.rb
-- lib/rocketeer/helpers/html.rb
 - lib/rocketeer/helpers/form.rb
+- lib/rocketeer/helpers/html.rb
 - lib/rocketeer/helpers/text.rb
-homepage: http://rubygems.org/gems/rocketeer
+- lib/rocketeer/version.rb
+- rocketeer.gemspec
+homepage: https://github.com/nirix/rockets
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -42,8 +48,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: A collection of helpers for Sinatra
+summary: A collection of helpers for Sinatra.
 test_files: []