sinatra_more 0.0.13 → 0.0.14

data/README.rdoc

@@ -98,21 +98,128 @@ methods should be very familiar to anyone who has used rails view helpers.
   
 ==== Form Helpers
 
-* form_for(object, url, settings={}, &block)
 * form_tag(url, options={}, &block)
+  * Constructs a form without object based on options
+  * form_tag('/register', :class => 'example') { ... }
 * field_set_tag(*args, &block)
+  * Constructs a field_set to group fields with given options
+  * field_set_tag(:class => 'office-set') { }
+  * field_set_tag("Office", :class => 'office-set') { }
 * error_messages_for(record, options={})
+  * Constructs list html for the errors for a given object
+  * error_messages_for @user
 * label_tag(name, options={}, &block)
+  * Constructs a label tag from the given options
+  * label_tag :username, :class => 'long-label'
+  * label_tag(:username, :class => 'blocked-label') { ... }
 * text_field_tag(name, options={})
+  * Constructs a text field input from the given options
+  * text_field_tag :username, :class => 'long'
 * text_area_tag(name, options={})
+  * Constructs a text area input from the given options
+  * text_area_tag :username, :class => 'long'
 * password_field_tag(name, options={})
+  * Constructs a password field input from the given options
+  * password_field_tag :password, :class => 'long'
 * file_field_tag(name, options={})
+  * Constructs a file field input from the given options
+  * file_field_tag :photo, :class => 'long'
 * submit_tag(caption, options={})
+  * Constructs a submit button from the given options
+  * submit_tag "Create", :class => 'success'
+
+A form_tag might look like:
+
+  - form_tag '/login', :class => 'login-form' do
+    = flash_tag(:notice)
+    - field_set_tag do
+      %p
+        = label_tag :username, :class => 'first'
+        = text_field_tag :username, :value => params[:username]
+      %p
+        = label_tag :password, :class => 'first'
+        = text_field_tag :password, :value => params[:password]
+    - field_set_tag(:class => 'buttons') do
+      = submit_tag "Login"
+    
+==== FormBuilders ====
+
+* form_for(object, url, settings={}, &block)
+  * Constructs a form using given or default form_builder
+  * form_for(@user, '/register', :id => 'register') { |f| ...field-elements... }
+
+The following are fields provided by AbstractFormBuilder that can be used within a form_for:
+
+* error_messages(options={})
+  * Displays list html for the errors on form object
+  * f.errors_messages
+* label(field, options={})
+  * f.label :name, :class => 'long'
+* text_field(field, options={})
+  * f.text_field :username, :class => 'long'
+* text_area(field, options={})
+  * f.text_area :summary, :class => 'long'
+* password_field(field, options={})
+  * f.password_field :secret, :class => 'long'
+* file_field(field, options={})
+  * f.file_field :photo, :class => 'long'
+* submit(caption, options={})
+  * f.submit "Update", :class => 'long'
+  
+A form_for using these basic fields might look like:
+
+  - form_for @user, '/register', :id => 'register' do |f|
+    = f.error_messages
+    %p
+      = f.label :username
+      = f.text_field :username
+    %p
+      = f.label :email
+      = f.text_field :email
+    %p
+      = f.label :password
+      = f.password_field :password
+    %p
+      = f.submit "Create"
+  
+There is also a StandardFormBuilder which builds on the abstract fields that can be used within a form_for:
+
+* text_field_block(field, options={}, label_options={})
+  * text_field_block(:nickname, :class => 'big', :caption => "Username")
+* text_area_block(field, options={}, label_options={})
+  * text_area_block(:about, :class => 'big')
+* password_field_block(field, options={}, label_options={})
+  * password_field_block(:code, :class => 'big')
+* file_field_block(field, options={}, label_options={})
+  * file_field_block(:photo, :class => 'big')
+* submit_block(caption, options={})
+  * submit_block(:username, :class => 'big')
+  
+A form_for using these standard fields might look like:
+
+  - form_for @user, '/register', :id => 'register' do |f|
+    = f.error_messages
+    = f.text_field_block :username
+    = f.text_field_block :email
+    = f.password_field_block :password
+    = f.submit_block "Create"
+
+and would generate this html:
+
+  <form id="register" action="/register" method="post">
+    <p><label for="user_name">Name: </label><input type="text" id="user_name" name="user[name]"></p>
+    ...omitted...
+    <p><input type="submit" value="Create"></p>
+  </form>
 
 ==== Format Helpers
 
 * relative_time_ago(date)
+  * Returns relative time in words referencing the given date
+  * relative_time_ago(2.days.ago) => "2 days ago"
 * escape_javascript(html_content)
+  * Escapes html to allow passing information to javascript. Used for passing data inside an ajax .js.erb template
+  * escape_javascript("<h1>Hey</h1>")
 
 === RenderPlugin
 
@@ -121,9 +228,19 @@ of displaying templates far smoother. This plugin also has support for useful ad
 such as partials (with support for :collection) into the templating system.
 
 * erb_template(template_path, options={})
+  * Renders a erb template based on the given path
+  * erb_template 'users/new'
 * haml_template(template_path, options={})
+  * Renders a haml template based on the given path
+  * haml_template 'users/new'
 * render_template(template_path, options={})
+  * Renders the first detected template based on the given path
+  * render_template 'users/new'
+  * render_template 'users/index', :template_engine => 'haml'
 * partial(template, *args)
+  * Renders the html related to the partial template for object or collection
+  * partial 'photo/_item', :object => @photo, :locals => { :foo => 'bar' }
+  * partial 'photo/_item', :collection => @photos
 
 === WardenPlugin
 
@@ -132,11 +249,20 @@ plugin registered, warden will be automatically required, configured and helpers
 provided to make interacting with warden dead simple.
 
 * current_user
+  * Returns the current authenticated user
 * authenticate_user!
+  * Login the user through the default warden strategies
 * logout_user!
+  * Signs out the user from the session
 * logged_in?
+  * Returns true if the user has been authenticated
 * authenticated?(&block)
+  * If a block is given, only yields the content if the user is authenticated
+  * authenticated? { puts "I am authenticated!" }
 * must_be_authorized!(failure_path=nil)
+  * Forces a user to return to a fail path unless they are authorized
+  * Used to require a user be authenticated before routing to an action
+  * must_be_authorized!('/login')
 
 == Acknowledgements
 

data/VERSION

@@ -1 +1 @@
-0.0.13
+0.0.14

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

@@ -17,9 +17,9 @@ class StandardFormBuilder < AbstractFormBuilder
   end
 
   # submit_block("Update")
-  def submit_block(caption)
+  def submit_block(caption, options={})
     @template.content_block_tag(:p) do
-      @template.submit_tag(caption)
+      @template.submit_tag(caption, options)
     end
   end
 end

data/lib/sinatra_more/markup_plugin/form_helpers.rb

@@ -1,20 +1,24 @@
 module SinatraMore
   module FormHelpers
+    # Constructs a form for object using given or default form_builder
     # form_for @user, '/register', :id => 'register' do |f| ... end
     def form_for(object, url, settings={}, &block)
-      configured_builder = settings[:builder] || self.options.default_builder.constantize
+      configured_builder = settings[:builder] || self.options.default_builder || 'StandardFormBuilder'
+      configured_builder = configured_builder.constantize if configured_builder.is_a?(String)
       settings.reverse_merge!(:method => 'post', :action => url)
       settings[:enctype] = "multipart/form-data" if settings.delete(:multipart)
       form_html = capture_html(configured_builder.new(self, object), &block)
       concat_content content_tag('form', form_html, settings)
     end
 
+    # Constructs a form without object based on options
     # form_tag '/register' do ... end
     def form_tag(url, options={}, &block)
       options.reverse_merge!(:method => 'post', :action => url)
       concat_content content_tag('form', capture_html(&block), options)
     end
     
+    # Constructs a field_set to group fields with given options
     # field_set_tag("Office", :class => 'office-set')
     # parameters: legend_text=nil, options={}
     def field_set_tag(*args, &block)
@@ -25,6 +29,7 @@ module SinatraMore
       concat_content content_tag('fieldset', field_set_content, options)
     end
 
+    # Constructs list html for the errors for a given object
     # error_messages_for @user
     def error_messages_for(record, options={})
       return "" if record.blank? or record.errors.none?
@@ -38,6 +43,7 @@ module SinatraMore
       end
     end
 
+    # Constructs a label tag from the given options
     # label_tag :username, :class => 'long-label'
     # label_tag :username, :class => 'long-label' do ... end
     def label_tag(name, options={}, &block)
@@ -51,30 +57,35 @@ module SinatraMore
       end
     end
 
+    # Constructs a text field input from the given options
     # text_field_tag :username, :class => 'long'
     def text_field_tag(name, options={})
       options.reverse_merge!(:name => name)
       input_tag(:text, options)
     end
 
+    # Constructs a text area input from the given options
     # text_area_tag :username, :class => 'long'
     def text_area_tag(name, options={})
       options.reverse_merge!(:name => name)
       content_tag(:textarea, '', options)
     end
 
+    # Constructs a password field input from the given options
     # 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 :photo, :class => 'long'
+    # Constructs a file field input from the given options
+    # file_field_tag :photo, :class => 'long'
     def file_field_tag(name, options={})
       options.reverse_merge!(:name => name)
       input_tag(:file, options)
     end
 
+    # Constructs a submit button from the given options
     # submit_tag "Create", :class => 'success'
     def submit_tag(caption, options={})
       options.reverse_merge!(:value => caption)

data/lib/sinatra_more/markup_plugin/format_helpers.rb

@@ -1,6 +1,7 @@
 module SinatraMore
   module FormatHelpers
     
+    # Returns relative time in words referencing the given date
     # relative_time_ago(Time.now)
     def relative_time_ago(date)
       date = date.to_date
@@ -18,8 +19,8 @@ module SinatraMore
       return date.strftime('%A, %B %e, %Y')
     end
 
-    # escape_javascript("<h1>Hey</h1>")
     # Used in xxxx.js.erb files to escape html so that it can be passed to javascript from sinatra
+    # escape_javascript("<h1>Hey</h1>")
     def escape_javascript(html_content)
       return '' unless html_content
       javascript_mapping = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n' }

data/lib/sinatra_more/render_plugin/render_helpers.rb

@@ -39,6 +39,7 @@ module SinatraMore
         render_template(template_path, options)
       end
     end
+    alias render_partial partial
 
     private
 

data/sinatra_more.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_more}
-  s.version = "0.0.13"
+  s.version = "0.0.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_more
 version: !ruby/object:Gem::Version 
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors: 
 - Nathan Esquenazi