kelredd-sinatra-helpers 0.1.0 → 0.1.1

data/README.rdoc

@@ -6,9 +6,20 @@ This is a ruby gem with a bunch of helpers to make Sinatra more useful.
 
 === Environment Tests
 
+Have environment tests like development? and production? available in your app code
+
 === Erb Helpers
 
-=== Mailer
+Helpful view template helpers for partial rendering and html generation.  See
+http://github.com/kelredd/useful/tree/master/lib/useful/erb_helpers/ for more info.
+
+=== Sprockets
+
+Coming.
+
+=== ActiveRecord
+
+Coming.
 
 == Installation
 

data/Rakefile

@@ -17,8 +17,7 @@ spec = Gem::Specification.new do |s|
   s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
   # s.executables    = ['sinatra-helpers']
   
-  s.add_dependency('kelredd-useful', '>= 0.1.25')
-  s.add_dependency('tmail', '>= 1.2.3.0')
+  s.add_dependency('kelredd-useful', '>= 0.2.0')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/sinatra_helpers/environment_tests.rb

@@ -1,5 +1,7 @@
 require 'sinatra/base'
 
+module SinatraHelpers; end
+
 module SinatraHelpers::EnvironmentTests
     
   def production? 

data/lib/sinatra_helpers/erb/partials.rb

@@ -1,13 +1,17 @@
+require 'erb'
 require 'sinatra/base'
 
+module SinatraHelpers; end
+module SinatraHelpers::Erb; end
+
 module SinatraHelpers::Erb::Partials
   
-  # helper to emulate rails 'render :partial' helper, using erb
+  # helper to emulate rails' 'render :partial' helper, using erb
   # => taken from the sinatra book, http://sinatra-book.gittr.com/#implemention_of_rails_style_partials
-  # Render the page once:
+  # Render the partial once:
   # Usage: partial :foo
   # 
-  # foo will be rendered once for each element in the array, passing in a local variable named "foo"
+  # foo partial will be rendered once for each element in the array, passing in a local variable named "foo"
   # Usage: partial :foo, :collection => @my_foos    
   def partial(template, options={})
     options.merge!(:layout => false)
@@ -17,14 +21,18 @@ module SinatraHelpers::Erb::Partials
     template = File.join(path).to_sym
     raise 'partial collection specified but is nil' if options.has_key?(:collection) && options[:collection].nil?
     if collection = options.delete(:collection)
+      options.delete(:object)  # ignore any object passed in when using :collection
       counter = 0
       collection.inject([]) do |buffer, member|
         counter += 1
-        buffer << erb(template, options.merge(:locals => {object => member, "#{object}_counter".to_sym => counter}))
+        options[:locals] ||= {}
+        options[:locals].merge!({object => member, "#{object}_counter".to_sym => counter})
+        buffer << erb(template, options)
       end.join("\n")
     else
       if member = options.delete(:object)
-        options.merge!(:locals => {object => member})
+        options[:locals] ||= {}
+        options[:locals].merge!({object => member})
       end
       erb(template, options)
     end
@@ -33,3 +41,4 @@ module SinatraHelpers::Erb::Partials
 end
   
 Sinatra::Application.helpers SinatraHelpers::Erb::Partials
+

data/lib/sinatra_helpers/erb.rb

@@ -1,4 +1,9 @@
-module SinatraHelpers::Erb; end
 Dir[File.join(File.dirname(__FILE__), "erb" ,"*.rb")].each do |file|
   require "sinatra_helpers/erb/#{File.basename(file, ".rb")}"
 end
+
+require "useful/erb_helpers"
+Sinatra::Application.helpers Useful::ErbHelpers::Tags
+Sinatra::Application.helpers Useful::ErbHelpers::Links
+Sinatra::Application.helpers Useful::ErbHelpers::Forms
+Sinatra::Application.helpers Useful::ErbHelpers::Proper

data/lib/sinatra_helpers/version.rb

@@ -3,7 +3,7 @@ module SinatraHelpers
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/lib/sinatra_helpers.rb

@@ -1,4 +1,2 @@
-module SinatraHelpers; end
 require 'sinatra_helpers/environment_tests'
 require 'sinatra_helpers/erb'
-require 'sinatra_helpers/mailer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kelredd-sinatra-helpers
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kelly Redding
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-13 00:00:00 -05:00
+date: 2009-11-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,17 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.25
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: tmail
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.3.0
+        version: 0.2.0
     version: 
 description: 
 email: kelly@kelredd.com
@@ -44,17 +34,8 @@ files:
 - README.rdoc
 - Rakefile
 - lib/sinatra_helpers/environment_tests.rb
-- lib/sinatra_helpers/erb/error_pages.rb
-- lib/sinatra_helpers/erb/forms.rb
-- lib/sinatra_helpers/erb/helpers.rb
-- lib/sinatra_helpers/erb/links.rb
 - lib/sinatra_helpers/erb/partials.rb
-- lib/sinatra_helpers/erb/tags.rb
 - lib/sinatra_helpers/erb.rb
-- lib/sinatra_helpers/mailer/base.rb
-- lib/sinatra_helpers/mailer/exceptions.rb
-- lib/sinatra_helpers/mailer/tls.rb
-- lib/sinatra_helpers/mailer.rb
 - lib/sinatra_helpers/version.rb
 - lib/sinatra_helpers.rb
 has_rdoc: true

data/lib/sinatra_helpers/erb/error_pages.rb

@@ -1,19 +0,0 @@
-require 'sinatra/base'
-
-module SinatraHelpers::Erb::ErrorPages
-      
-  def self.registered(app)
-    app.configure :production do
-      app.not_found do
-        erb :'404.html'
-      end
-      app.error do
-        @err = request.env['sinatra_error']
-        erb :'500.html'
-      end
-    end
-  end
-      
-end
-
-Sinatra::Application.register SinatraHelpers::Erb::ErrorPages

data/lib/sinatra_helpers/erb/forms.rb

@@ -1,125 +0,0 @@
-require 'sinatra/base'
-require 'sinatra_helpers/erb/helpers')
-require 'sinatra_helpers/erb/tags')
-
-module SinatraHelpers::Erb::Forms
-      
-  include SinatraHelpers::Erb::Helpers
-  
-  def form_tag(url, options={}, &block) 
-    options[:method] = 'post' unless ['get','post','put','delete'].include?(options[:method])
-    options.update :action => url
-    if multipart = options.delete(:multipart)
-      options[:enctype] = sinatra_erb_helper_multipart_option
-    end
-    if block_given?
-      @_out_buf << tag(:form, options) { sinatra_erb_helper_capture(&block) }
-    else
-      tag(:form, options)
-    end
-  end
-  
-  def field_set_tag(legend=nil, options={}, &block)
-    legend_html = legend.nil? ? '' : tag(:legend) { legend.to_s }
-    if block_given?
-      @_out_buf << tag(:fieldset, options) { legend_html + sinatra_erb_helper_capture(&block) }
-    else
-      tag(:fieldset, options) { legend_html }
-    end
-  end
-  
-  def label_tag(name, value=nil, options={})
-    value ||= name.to_s.capitalize
-    options.update :for => name.to_s
-    tag(:label, options) { value }
-  end
-  
-  def hidden_field_tag(name, value=nil, options={}) 
-    input_tag('hidden', name, value, options)
-  end
-  
-  def password_field_tag(name="password", value=nil, options={}) 
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    input_tag('password', name, value, options)
-  end
-  
-  def file_field_tag(name, options={})
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    input_tag('file', name, nil, options)
-  end
-  
- def check_box_tag(name, label=nil, value='1', checked=false, options={})
-    tag_name = options.delete(:tag) || :div
-    if options.has_key?(:class)
-      options[:class] += ' checkbox'
-    else
-      options[:class] = 'checkbox'
-    end
-    options[:id] ||= sinatra_erb_helper_safe_id(rand(1000).to_s)
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    options[:checked] = sinatra_erb_helper_checked_option if checked
-    input_str = input_tag('checkbox', name, value, options)
-    if label.nil?
-      input_str
-    else
-      tag(tag_name, :class => 'checkbox') { input_str + label_tag(options[:id], label)  }
-    end
-  end
-  
-  def radio_button_tag(name, value, label=nil, checked=false, options={}) 
-    tag_name = options.delete(:tag) || :span
-    if options.has_key?(:class)
-      options[:class] += ' radiobutton'
-    else
-      options[:class] = 'radiobutton'
-    end
-    label ||= value.to_s.capitalize
-    options[:id] ||= sinatra_erb_helper_safe_id(rand(1000).to_s)
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    options[:checked] = sinatra_erb_helper_checked_option if checked
-    input_str = input_tag('radio', name, value, options)
-    if label.nil?
-      input_str
-    else
-      label_tag(options[:id], input_str + tag(tag_name) { label }, :class => options.delete(:class))
-    end
-  end
-  
-  def select_tag(name, options={}, &block) 
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    html_name = (options[:multiple] == true && !name.to_s[(name.to_s.length-2)..-1] == "[]") ? "#{name}[]" : name
-    options[:multiple] = sinatra_erb_helper_multiple_option if options[:multiple] == true
-    options[:tag] = 'select'
-    if block_given?
-      @_out_buf << input_tag(:select, html_name, nil, options) { sinatra_erb_helper_capture(&block) }
-    else
-      input_tag(:select, html_name, nil, options)
-    end
-  end
-
-  def text_area_tag(name, content=nil, options={}) 
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    options[:tag] = 'textarea'
-    input_tag(nil, name, nil, options) { content || '' }
-  end
-  
-  def text_field_tag(name, value=nil, options={}) 
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    input_tag('text', name, value, options)
-  end
-  
-  def submit_tag(value="Save", options={}) 
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    input_tag('submit', 'commit', value, options)
-  end
-  
-  def image_submit_tag(source, options={})
-    options[:disabled] = sinatra_erb_helper_disabled_option if options[:disabled]
-    options[:src] = source
-    options[:alt] ||= 'Save'
-    input_tag('image', nil, nil, options)
-  end
-  
-end
-
-Sinatra::Application.helpers SinatraHelpers::Erb::Forms

data/lib/sinatra_helpers/erb/helpers.rb

@@ -1,39 +0,0 @@
-module SinatraHelpers::Erb::Helpers
-  
-  def sinatra_erb_helper_safe_id(id)
-    id.gsub(/\W/,'')
-  end
-  
-  def sinatra_erb_helper_capture(*args, &block)
-    sinatra_erb_helper_with_output_buffer { block.call(*args) }
-  end
-  
-  def sinatra_erb_helper_with_output_buffer(buf = '') #:nodoc:
-    @_out_buf, old_buffer = buf, @_out_buf
-    yield
-    @_out_buf
-  ensure
-    @_out_buf = old_buffer
-  end
-  
-  def sinatra_erb_helper_hash_to_html_attrs(a_hash)
-    a_hash.collect{|key, val| "#{key}=\"#{val}\""}.join(' ')
-  end
-
-  def sinatra_erb_helper_disabled_option
-    'disabled' 
-  end
-  
-  def sinatra_erb_helper_checked_option
-    'checked'
-  end
-  
-  def sinatra_erb_helper_multiple_option
-    'multiple'
-  end
-  
-  def sinatra_erb_helper_multipart_option
-    'multipart/form-data'
-  end
-  
-end      

data/lib/sinatra_helpers/erb/links.rb

@@ -1,73 +0,0 @@
-require 'sinatra/base'
-require 'sinatra_helpers/erb/tags')
-
-module SinatraHelpers::Erb::Links
-  
-  # helper to emulate action view's 'link_to'
-  # EX : link_to "google", "http://google.com"
-  # => <a href="http://google.com">google</a>
-  def link_to(content,href,options={})
-    options.update :href => href
-    tag(:a, options) { content }
-  end
-  
-  def open_link_to(content, href, options={})
-    options[:onclick] = "javascript: window.open('#{href}'); return false;"
-    link_to(content, href, options)
-  end
-
-  def mail_link_to(email, options={})
-    link_to options[:label] || email, "mailto: #{email}"
-  end
-
-  def link_to_function(content, function, opts={})
-    opts ||= {}
-    opts[:href] ||= 'javascript: void(0);'
-    opts[:onclick] = "javascript: #{function}; return false;"
-    link_to content, opts[:href], opts
-  end
-
-  # helper to emulate 'image_tag'
-  # EX : image_tag 'logo.jpg'
-  #  => <img src="images/logo.jpg" />
-  def image_tag(src,options={})
-    options[:src] = ['/'].include?(src[0..0]) ? src : "/images/#{src}"
-    tag(:img, options)
-  end
-
-  # helper to emulate 'stylesheet_link_tag'
-  # EX : stylesheet_link_tag 'default'
-  #  => <link rel="stylesheet" href="/stylesheets/default.css" type="text/css" media="all" title="no title" charset="utf-8">
-  def stylesheet_link_tag(srcs,options={})
-    options[:media] ||=  "screen"
-    options[:type] ||= "text/css"
-    options[:rel] ||= "stylesheet"
-    srcs.to_a.collect do |src|
-      options[:href] = "/stylesheets/#{src}.css#{"?#{Time.now.to_i}" if Sinatra::Application.environment.to_s == 'development'}"
-      tag(:link, options)
-    end.join("\n")
-  end
-
-  # helper to emulate 'javascript_include_tag'
-  # EX : javascript_include_tag 'app'
-  #  => <script src="/js/app.js" type="text/javascript" />  
-  # EX : javascript_include_tag ['app', 'jquery']
-  #  => <script src="/js/app.js" type="text/javascript" />
-  #  => <script src="/js/jquery.js" type="text/javascript" />
-  def javascript_include_tag(srcs,options={})
-    options[:type] ||= "text/javascript"
-    srcs.to_a.collect do |src|
-      options[:src] = "/javascripts/#{src}.js#{"?#{Time.now.to_i}" if Sinatra::Application.environment.to_s == 'development'}"
-      tag(:script, options) { '' }
-    end.join("\n")
-  end
-
-  # helper to emulate 'javascript_tag'
-  def javascript_tag(options={})
-    options[:type] ||= "text/javascript"
-    tag(:script, options) { yield }
-  end
-
-end
-  
-Sinatra::Application.helpers SinatraHelpers::Erb::Links

data/lib/sinatra_helpers/erb/tags.rb

@@ -1,50 +0,0 @@
-require 'sinatra/base'
-require 'sinatra_helpers/erb/helpers.rb')
-
-module SinatraHelpers::Erb::Tags
-  
-  include SinatraHelpers::Erb::Helpers
-  
-  def input_tag(type, name, value, options={}, &block)
-    options[:tag] ||= :input
-    options[:type] = type unless type.nil?
-    unless name.nil?
-      options[:name] = name 
-      options[:id] ||= sinatra_erb_helper_safe_id(name)
-    end
-    options[:value] = value unless value.nil?
-    tag(options.delete(:tag), options, &block)
-  end
-
-  def clear_tag(options={})
-    options[:tag] ||= :div
-    options[:style] ||= ''
-    options[:style] = "clear: both;#{options[:style]}"
-    tag(options.delete(:tag), options) { '' }
-  end
-
-  # helpers to escape tag text content
-  include Rack::Utils
-  alias_method :h, :escape_html
-  
-  # escape tag text content and format for text like display
-  def h_text(text, opts={})
-    h(text.to_s).
-      gsub(/\r\n?/, "\n").  # \r\n and \r -> \n
-      split("\n").collect do |line|
-        line.nil? ? '': line.sub(/(\s+)?\S*/) {|lead| lead.gsub(/\s/,' ')}
-      end.join("\n"). # change any leading white spaces on a line to ' '
-      gsub(/\n/,'\1<br />') # newlines -> br added
-  end
-
-  # emulator for 'tag'
-  # EX : tag :h1, "shizam", :title => "shizam"
-  # => <h1 title="shizam">shizam</h1>
-  def tag(name, options={})
-    "<#{name.to_s} #{sinatra_erb_helper_hash_to_html_attrs(options)} #{block_given? ? ">#{yield}</#{name}" : "/"}>"
-  end
-  
-end      
-
-Sinatra::Application.helpers SinatraHelpers::Erb::Tags
-

data/lib/sinatra_helpers/mailer/base.rb

@@ -1,83 +0,0 @@
-require 'openssl'
-require 'net/smtp'
-require 'tmail'
-require 'sinatra/base'
-require 'sinatra_helpers/mailer/exceptions'
-require 'sinatra_helpers/mailer/tls'
-
-module SinatraHelpers::Mailer
-  class Base
-    
-    CONFIGS = [:server, :domain, :port, :reply_to, :username, :password, :authentication, :content_type, :charset]
-    CONFIGS.each do |config|
-      attr_reader config
-    end
-    attr_accessor :logger
-    
-    def initialize(configs={})
-      CONFIGS.each do |config|
-        instance_variable_set("@#{config}", configs[config])
-      end
-      @authentication ||= :login
-      @reply_to ||= @username
-      @content_type ||= 'text/plain'
-      @charset ||= 'UTF-8'
-      @logger = block_given? ? yield : nil
-    end
-    
-    def send(settings={})
-      check_configs
-      [:to, :subject].each do |setting|
-        raise SinatraHelpers::Mailer::SendError, "cannot send, #{setting} not specified." unless settings[setting]
-      end
-      mail = generate_mail(settings)
-      mail.body = yield(mail) if block_given?
-      mail.body ||= ''
-      Sinatra::Application.environment.to_s == 'production' ? send_mail(mail) : log_mail(mail)
-      log(:info, "Sent '#{mail.subject}' to #{mail.to.join(',')}")
-      mail
-    end
-    
-    protected
-    
-    def check_configs
-      CONFIGS.each do |config|
-        raise SinatraHelpers::Mailer::ConfigError, "#{config} not configured." unless instance_variable_get("@#{config}")
-      end
-    end
-    
-    def generate_mail(settings)
-      mail = TMail::Mail.new
-      mail.to = Array.new([settings[:to]])
-      mail.from = @reply_to
-      mail.reply_to = @reply_to
-      mail.subject = settings[:subject]
-      mail.date = Time.now
-      mail.set_content_type @content_type
-      mail.charset = @charset
-      mail
-    end
-    
-    def send_mail(mail)
-      raise SinatraHelpers::Mailer::SendError, "cannot send, bad (or empty) mail object given." unless mail
-      Net::SMTP.start(@server, @port, @domain, @username, @password, @authentication) do |server|
-        mail.to.each {|recipient| server.send_message(mail.to_s, mail.from, recipient) }
-      end
-    end
-    
-    def log_mail(mail)
-      log(:debug, mail.to_s)
-    end
-    
-    def log(level, msg)
-      if(msg)
-        if @logger && @logger.respond_to?(level)
-          @logger.send(level.to_s, msg) 
-        else
-          puts "** [#{level.to_s.upcase}]: [Mailer] #{msg}"
-        end
-      end
-    end
-    
-  end
-end

data/lib/sinatra_helpers/mailer/exceptions.rb

@@ -1,12 +0,0 @@
-module SinatraHelpers::Mailer
-
-  class MailerError < StandardError
-  end
-  
-  class ConfigError < MailerError
-  end
-  
-  class SendError < MailerError
-  end
-
-end

data/lib/sinatra_helpers/mailer/tls.rb

@@ -1,73 +0,0 @@
-# Note: This is a complete rip of http://github.com/ambethia/smtp-tls/tree/master
-# => I chose to copy the source in here instead of add yet another gem depencency
-# => I take no credit for this work, check out link for more info.
-
-require 'net/smtp'
-
-Net::SMTP.class_eval do
-  private
-  def do_start(helodomain, user, secret, authtype)
-    raise IOError, 'SMTP session already started' if @started
-    
-    if RUBY_VERSION > "1.8.6"
-      check_auth_args user, secret if user or secret
-    else
-      check_auth_args user, secret, authtype if user or secret
-    end
- 
-    sock = timeout(@open_timeout) { TCPSocket.open(@address, @port) }
-    @socket = Net::InternetMessageIO.new(sock)
-    @socket.read_timeout = 60 #@read_timeout
- 
-    check_response(critical { recv_response() })
-    do_helo(helodomain)
- 
-    if starttls
-      raise 'openssl library not installed' unless defined?(OpenSSL)
-      ssl = OpenSSL::SSL::SSLSocket.new(sock)
-      ssl.sync_close = true
-      ssl.connect
-      @socket = Net::InternetMessageIO.new(ssl)
-      @socket.read_timeout = 60 #@read_timeout
-      do_helo(helodomain)
-    end
- 
-    authenticate user, secret, authtype if user
-    @started = true
-  ensure
-    unless @started
-      # authentication failed, cancel connection.
-      @socket.close if not @started and @socket and not @socket.closed?
-      @socket = nil
-    end
-  end
- 
-  def do_helo(helodomain)
-    begin
-      if @esmtp
-        ehlo helodomain
-      else
-        helo helodomain
-      end
-    rescue Net::ProtocolError
-      if @esmtp
-        @esmtp = false
-        @error_occured = false
-        retry
-      end
-      raise
-    end
-  end
- 
-  def starttls
-    getok('STARTTLS') rescue return false
-  return true
-  end
- 
-  def quit
-    begin
-      getok('QUIT')
-    rescue EOFError
-    end
-  end
-end

data/lib/sinatra_helpers/mailer.rb

@@ -1,4 +0,0 @@
-module SinatraHelpers::Mailer; end
-Dir[File.join(File.dirname(__FILE__), "mailer" ,"*.rb")].each do |file|
-  require "sinatra_helpers/mailer/#{File.basename(file, ".rb")}"
-end