sinatra_more 0.0.7 → 0.0.8

data/README.rdoc

@@ -2,7 +2,10 @@
 
 == Introduction
 
-This will be a plugin which expand sinatra's capabilities in many ways. Not ready to be used yet!
+(Not quite ready to be used yet!)
+
+This will be a plugin which expand sinatra's capabilities in many ways. 
+Note that certain template specific helpers are known to work with haml, erb, and erubis
 
 Let me expand briefly on what I want to accomplish with this gem. I love sinatra but if I want to use it
 for any non-trivial application I very quickly miss a lot of the extra tools provided by rails.
@@ -68,6 +71,15 @@ provided to make interacting with warden dead simple.
 
 ...list methods here...
 
+== Acknowledgements
+
+Thanks to keldredd for the sinatra-helpers code that helped me to create erb capture and concat methods!
+
+== Contributers
+
+* Nathan Esquenazi - Project creator and code maintainer
+* Arthur Chiu      - Forming the idea and various code contributions
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/TODO

@@ -1,5 +1,13 @@
-* I have got to add tests, basically create dummy sinatra applications and use Rack::Test
-* Pull from sinatra-helpers and make erb templates work (and credit keldredd)
-  - http://github.com/kelredd/sinatra-helpers/tree/master/lib/sinatra_helpers/erb/
+= UNFINISHED
+
+* image_tag should start in images_path (or /images)
+* I have got to add tests, basically create dummy sinatra applications and use Webrat
 * Become total warden solution (basically just require warden gem installed, do everything else)
-* Remove dependency on activesupport! and enumerate dependencies in rake
+  * Make warden password strategy support a callback which explains what to do with username, password
+  * WardenPlugin.authenticate_callback { |username, password| User.authenticate(username, password) }
+* Remove dependency on activesupport! and enumerate dependencies in rakefile
+
+= COMPLETED
+
+* Pull from sinatra-helpers and make erb templates work (and credit keldredd)
+  - http://github.com/kelredd/sinatra-helpers/tree/master/lib/sinatra_helpers/erb/

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/sinatra_more/markup_plugin/asset_tag_helpers.rb

@@ -1,6 +1,7 @@
 module SinatraMore
   module AssetTagHelpers
-    # flash_tag(:notice)
+    
+    # flash_tag(:notice, :class => 'flash', :id => 'flash-notice')
     def flash_tag(kind, options={})
       flash_text = flash[kind]
       return '' if flash_text.blank?
@@ -8,13 +9,14 @@ module SinatraMore
       content_tag(:div, flash_text, options)
     end
     
-    # name, url='javascript:void(0)', options={}, &block
+    # link_to 'click me', '/dashboard', :class => 'linky'
+    # parameters: name, url='javascript:void(0)', options={}, &block
     def link_to(*args, &block)
       if block_given?
         url, options = (args[0] || 'javascript:void(0);'), (args[1] || {})
         options.reverse_merge!(:href => url)
-        link_content = capture_haml(&block)
-        haml_concat(content_tag(:a, link_content, options))
+        link_content = capture_html(&block)
+        concat_content(content_tag(:a, link_content, options))
       else
         name, url, options = args.first, (args[1] || 'javascript:void(0);'), (args[2] || {})
         options.reverse_merge!(:href => url)
@@ -22,27 +24,32 @@ module SinatraMore
       end
     end
 
+    # image_tag('icons/avatar.png')
     def image_tag(url, options={})
       options.reverse_merge!(:src => url)
       tag(:img, options)
     end
 
+    # stylesheet_link_tag 'style', 'application', 'layout'
     def stylesheet_link_tag(*sources)
       options = sources.extract_options!.symbolize_keys
       sources.collect { |sheet| stylesheet_tag(sheet, options) }.join("\n")
     end
 
+    # stylesheet_tag('style', :media => 'screen')
     def stylesheet_tag(source, options={})
       rel_path = "/stylesheets/#{source}.css?#{Time.now.to_i}"
       options = options.dup.reverse_merge!(:href => rel_path, :media => 'screen', :rel => 'stylesheet', :type => 'text/css')
       tag(:link, options)
     end
 
+    # javascript_include_tag 'application', 'special'
     def javascript_include_tag(*sources)
       options = sources.extract_options!.symbolize_keys
       sources.collect { |script| javascript_tag(script, options) }.join("\n")
     end
 
+    # javascript_tag 'application', :src => '/javascripts/base/application.js'
     def javascript_tag(source, options={})
       rel_path = "/javascripts/#{source}.js?#{Time.now.to_i}"
       options = options.dup.reverse_merge!(:content => "", :src => rel_path, :type => 'text/javascript')

data/lib/sinatra_more/markup_plugin/form_builder/abstract_form_builder.rb

@@ -8,59 +8,75 @@ class AbstractFormBuilder
     @object   = object
   end
   
+  # f.error_messages
   def error_messages(options={})
     @template.error_messages_for(@object, options)
   end
   
+  # f.label :username, :caption => "Nickname"
   def label(field, options={})
     options.reverse_merge!(:caption => field.to_s.titleize)
     @template.label_tag(field_id(field), options)
   end
   
+  # f.text_field :username, :value => "(blank)", :id => 'username'
   def text_field(field, options={})
     options.reverse_merge!(:value => field_value(field), :id => field_id(field))
     @template.text_field_tag field_name(field), options
   end
   
+  # f.text_area :summary, :value => "(enter summary)", :id => 'summary'
   def text_area(field, options={})
     options.reverse_merge!(:value => field_value(field), :id => field_id(field))
     @template.text_area_tag field_name(field), options
   end
   
+  # f.password_field :password, :id => 'password'
   def password_field(field, options={})
     options.reverse_merge!(:value => field_value(field), :id => field_id(field))
     @template.password_field_tag field_name(field), options
   end
   
+  # f.file_field(:photo, :class => 'avatar')
   def file_field(field, options={})
     options.reverse_merge!(:id => field_id(field))
     @template.file_field_tag field_name(field), options
   end
   
+  # f.submit "Update", :class => 'large'
   def submit(caption, options={})
     @template.submit_tag caption, options
   end
   
   protected
   
+  # Returns the known field types for a formbuilder
   def self.field_types
     [:text_field, :text_area, :password_field, :file_field]
   end
   
   private
   
+  # Returns the object's models name
+  #   => user_assignment
   def object_name
     object.class.to_s.underscore
   end
   
+  # Returns the value for the object's field
+  # field_value(:username) => "Joey"
   def field_value(field)
     @object && @object.respond_to?(field) ? @object.send(field) : ""
   end
   
+  # Returns the name for the given field
+  # field_name(:username) => "user[username]"
   def field_name(field)
     "#{object_name}[#{field}]"
   end
   
+  # Returns the id for the given field
+  # field_id(:username) => "user_username"
   def field_id(field)
     "#{object_name}_#{field}"
   end

data/lib/sinatra_more/markup_plugin/form_builder/standard_form_builder.rb

@@ -1,4 +1,9 @@
 class StandardFormBuilder < AbstractFormBuilder
+  
+  # text_field_block(:username, { :class => 'long' }, { :class => 'wide-label' })
+  # text_area_block(:username, { :class => 'long' }, { :class => 'wide-label' })
+  # password_field_block(:username, { :class => 'long' }, { :class => 'wide-label' })
+  # file_field_block(:username, { :class => 'long' }, { :class => 'wide-label' })
   self.field_types.each do |field_type|
     class_eval <<-EOF
     def #{field_type}_block(field, options={}, label_options={})
@@ -11,6 +16,7 @@ class StandardFormBuilder < AbstractFormBuilder
     EOF
   end
 
+  # submit_block("Update")
   def submit_block(caption)
     @template.content_block_tag(:p) do
       @template.submit_tag(caption)

data/lib/sinatra_more/markup_plugin/form_helpers.rb

@@ -1,28 +1,28 @@
 module SinatraMore
   module FormHelpers
-    # form_for @user, '/register', :id => 'register'
+    # form_for @user, '/register', :id => 'register' do |f| ... end
     def form_for(object, url, settings={}, &block)
-      default_builder = settings[:builder] || self.options.default_builder.constantize
+      configured_builder = settings[:builder] || self.options.default_builder.constantize
       settings.reverse_merge!(:method => 'post', :action => url)
       settings[:enctype] = "multipart/form-data" if settings.delete(:multipart)
-      # TODO make this work with erb!!
-      form_html = capture_haml(default_builder.new(self, object), &block)
-      haml_concat content_tag('form', form_html, settings)
+      form_html = capture_html(configured_builder.new(self, object), &block)
+      concat_content content_tag('form', form_html, settings)
     end
 
     # form_tag '/register' do ... end
     def form_tag(url, options={}, &block)
       options.reverse_merge!(:method => 'post', :action => url)
-      # TODO make this work with erb!!
-      haml_concat content_tag('form', capture_haml(&block), options)
+      concat_content content_tag('form', capture_html(&block), options)
     end
     
-    def field_set_tag(legend=nil, options={}, &block)
-      # TODO make this work with erb!!
-      field_set_content = ''
-      field_set_content << content_tag(:legend, legend)  if legend.present?
-      field_set_content << capture_haml(&block)
-      haml_concat content_tag('fieldset', field_set_content, options)
+    # field_set_tag("Office", :class => 'office-set')
+    # parameters: legend_text=nil, options={}
+    def field_set_tag(*args, &block)
+      options = args.extract_options!
+      legend_text = args[0].is_a?(String) ? args.first : nil
+      legend_html = legend_text.blank? ? '' : content_tag(:legend, legend_text)
+      field_set_content = legend_html + capture_html(&block)
+      concat_content content_tag('fieldset', field_set_content, options)
     end
 
     # error_messages_for @user
@@ -38,44 +38,44 @@ module SinatraMore
       end
     end
 
-    # label_tag :username
+    # label_tag :username, :class => 'long-label'
+    # label_tag :username, :class => 'long-label' do ... end
     def label_tag(name, options={}, &block)
       options.reverse_merge!(:caption => name.to_s.titleize, :for => name)
       caption_text = options.delete(:caption) + ": "
-      # TODO make this work with erb!!
       if block_given? # label with inner content
-        label_content = caption_text + capture_haml(&block)
-        haml_concat(content_tag(:label, label_content, options))
+        label_content = caption_text + capture_html(&block)
+        concat_content(content_tag(:label, label_content, options))
       else # regular label
         content_tag(:label, caption_text, options)
       end
     end
 
-    # text_field_tag :username
+    # text_field_tag :username, :class => 'long'
     def text_field_tag(name, options={})
       options.reverse_merge!(:name => name)
       input_tag(:text, options)
     end
 
-    # text_field_tag :username
+    # text_area_tag :username, :class => 'long'
     def text_area_tag(name, options={})
       options.reverse_merge!(:name => name)
       content_tag(:textarea, '', options)
     end
 
-    # password_field_tag :password
+    # password_field_tag :password, :class => 'long'
     def password_field_tag(name, options={})
       options.reverse_merge!(:name => name)
       input_tag(:password, options)
     end
 
-    # field_field_tag
+    # field_field_tag :photo, :class => 'long'
     def file_field_tag(name, options={})
       options.reverse_merge!(:name => name)
       input_tag(:file, options)
     end
 
-    # submit_tag "Create"
+    # submit_tag "Create", :class => 'success'
     def submit_tag(caption, options={})
       options.reverse_merge!(:value => caption)
       input_tag(:submit, options)

data/lib/sinatra_more/markup_plugin/format_helpers.rb

@@ -1,5 +1,7 @@
 module SinatraMore
   module FormatHelpers
+    
+    # relative_time_ago(Time.now)
     def relative_time_ago(date)
       date = date.to_date
       date = Date.parse(date, true) unless /Date.*/ =~ date.class.to_s
@@ -16,15 +18,18 @@ module SinatraMore
       return date.strftime('%A, %B %e, %Y')
     end
 
-    def escape_javascript(javascript)
-      return '' unless javascript
+    # escape_javascript("<h1>Hey</h1>")
+    # Used in xxxx.js.erb files to escape html so that it can be passed to javascript from sinatra
+    def escape_javascript(html_content)
+      return '' unless html_content
       javascript_mapping = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n' }
       javascript_mapping.merge("\r" => '\n', '"' => '\\"', "'" => "\\'")
-      escaped_string = javascript.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { javascript_mapping[$1] }
+      escaped_string = html_content.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { javascript_mapping[$1] }
       "\"#{escaped_string}\""
     end
 
     alias js_escape escape_javascript
+    alias escape_for_javascript escape_javascript
 
   end
 end

data/lib/sinatra_more/markup_plugin/output_helpers.rb

@@ -0,0 +1,38 @@
+module SinatraMore
+  module OutputHelpers
+    # Captures the html from a block of template code for erb or haml
+    # capture_html(&block) => "...html..."
+    def capture_html(*args, &block)
+      if is_haml?
+         block_is_haml?(block) ? capture_haml(*args, &block) : block.call
+      else
+        capture_erb(*args, &block)
+      end
+    end
+    
+    # Outputs the given text to the templates buffer directly
+    # concat_content("This will be output to the template buffer in erb or haml")
+    def concat_content(text="")
+      if is_haml?
+        haml_concat(text)
+      else
+        @_out_buf << text
+      end
+    end
+
+    # Used to capture the html from a block of erb code
+    # capture_erb(&block) => '...html...'
+    def capture_erb(*args, &block)
+      erb_with_output_buffer { block.call(*args) }
+    end
+
+    # Used to direct the buffer for the erb capture
+    def erb_with_output_buffer(buf = '') #:nodoc:
+      @_out_buf, old_buffer = buf, @_out_buf
+      yield
+      @_out_buf
+    ensure
+      @_out_buf = old_buffer
+    end
+  end
+end

data/lib/sinatra_more/markup_plugin/tag_helpers.rb

@@ -6,16 +6,19 @@ module SinatraMore
       tag(:input, options)
     end
 
+    # content_block_tag(:p, :class => 'dark') do ... end
     def content_block_tag(name, options={}, &block)
-      # TODO make this work with erb!!
-      options.merge!(:content => block.call)
+      options.merge!(:content => capture_html(&block))
       tag(name, options)
     end
 
+    # content_tag(:p, "hello", :class => 'light')
     def content_tag(name, content, options={})
       tag(name, options.merge(:content => content))
     end
 
+    # tag(:br, :style => 'clear:both')
+    # tag(:p, :content => "hello", :class => 'large')
     def tag(name, options={})
       content = options.delete(:content)
       html_attrs = options.collect { |a, v| v.blank? ? nil : "#{a}=\"#{v}\"" }.compact.join(" ")

data/lib/sinatra_more/markup_plugin.rb

@@ -3,6 +3,7 @@ Dir.glob(File.dirname(__FILE__) + '/markup_plugin/**/*.rb').each  { |f| require
 module SinatraMore
   module MarkupPlugin
     def self.registered(app)
+      app.helpers OutputHelpers
       app.helpers TagHelpers
       app.helpers AssetTagHelpers
       app.helpers FormHelpers

data/lib/sinatra_more/warden_plugin/warden_helpers.rb

@@ -25,8 +25,8 @@ module SinatraMore
     def authenticated?(&block)
       if block_given?
         return '' unless logged_in?
-        authenticated_content = capture_haml(&block)
-        haml_concat(authenticated_content)
+        authenticated_content = capture_html(&block)
+        concat_content(authenticated_content)
       else
         return logged_in?
       end
@@ -37,8 +37,8 @@ module SinatraMore
     def unregistered?(&block)
       if block_given?
         return '' if logged_in?
-        unregistered_content = capture_haml(&block)
-        haml_concat(unregistered_content)
+        unregistered_content = capture_html(&block)
+        concat_content(unregistered_content)
       else
         return !logged_in?
       end      

data/lib/sinatra_more/warden_plugin.rb

@@ -15,13 +15,21 @@ module SinatraMore
 
       Warden::Strategies.add(:password) do
         def valid?
-          params['username'] || params['password']
+          username || password
         end
 
         def authenticate!
-          u = User.authenticate(params['username'], params['password'])
+          u = User.authenticate(username, password)
           u.nil? ? fail!("Could not log in") : success!(u)
         end
+        
+        def username
+          params['username'] || params['nickname'] || params['login'] || params['email']
+        end
+        
+        def password
+          params['password'] || params['pass']
+        end
       end
     end
   end

data/sinatra_more.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_more}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/sinatra_more/markup_plugin/form_builder/standard_form_builder.rb",
      "lib/sinatra_more/markup_plugin/form_helpers.rb",
      "lib/sinatra_more/markup_plugin/format_helpers.rb",
+     "lib/sinatra_more/markup_plugin/output_helpers.rb",
      "lib/sinatra_more/markup_plugin/tag_helpers.rb",
      "lib/sinatra_more/render_plugin.rb",
      "lib/sinatra_more/render_plugin/render_helpers.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_more
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -46,6 +46,7 @@ files:
 - lib/sinatra_more/markup_plugin/form_builder/standard_form_builder.rb
 - lib/sinatra_more/markup_plugin/form_helpers.rb
 - lib/sinatra_more/markup_plugin/format_helpers.rb
+- lib/sinatra_more/markup_plugin/output_helpers.rb
 - lib/sinatra_more/markup_plugin/tag_helpers.rb
 - lib/sinatra_more/render_plugin.rb
 - lib/sinatra_more/render_plugin/render_helpers.rb