viewaide 0.3.1 → 0.3.2

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gemspec.email = "joshua.clayton@gmail.com"
     gemspec.homepage = "http://github.com/joshuaclayton/viewaide"
     gemspec.authors = ["Joshua Clayton"]
-    gemspec.add_dependency("actionview", ">= 2.1.0")
+    gemspec.add_dependency("actionpack", ">= 2.1.0")
     gemspec.add_dependency("activesupport", ">= 2.1.0")
     gemspec.add_dependency("hpricot", ">= 0.8.1")
   end

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/viewaide/helpers/date_helper.rb

@@ -1,11 +1,22 @@
 module Viewaide
   module Helpers
     module DateHelper
-
+      # Converts a date or time object to a formatted time
+      #
+      # @param [Date, Time, or DateTime] dt the date to convert
+      # @param [String] default_text default text if the date is nil
+      # @param [Symbol] format_string the time format
+      # @return [String]
       def datetime(dt = nil, default_text = "", format_string = :long)
         dt ? dt.to_time.to_s(format_string) : default_text
       end
 
+      # Converts a date or time object to a formatted date
+      #
+      # @param [Date, Time, or DateTime] dt the date to convert
+      # @param [String] default_text default text if the date is nil
+      # @param [Symbol] format_string the date format
+      # @return [String]
       def date(dt = nil, default_text = "", format_string = :long)
         dt ? dt.to_date.to_s(format_string) : default_text
       end

data/lib/viewaide/helpers/form_helper.rb

@@ -2,6 +2,38 @@ module Viewaide
   module Helpers
     module FormHelper
 
+      # Generates a submit button for forms
+      #
+      # @param [String] value the text for the button
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <%= submit_button "Create" %>
+      #   generates
+      #   <button class="btn" type="submit" value="Create">
+      #     <span>Create</span>
+      #   </button>
+      #
+      # @example
+      #   <%= submit_button "Create", :class1, :class2, "another-class" %>
+      #   generates
+      #   <button class="btn class1 class2 another-class" type="submit" value="Create">
+      #     <span>Create</span>
+      #   </button>
+      #
+      # @example
+      #   <%= submit_button "Create", :class1, :id => "custom", :type => "image" %>
+      #   generates
+      #   <button class="btn class1" type="image" id="custom" value="Create">
+      #     <span>Create</span>
+      #   </button>
+      #
+      # @example
+      #   <%= submit_button "Create", :class1, :value => "override" %>
+      #   generates
+      #   <button class="btn class1" type="submit" value="override">
+      #     <span>Create</span>
+      #   </button>
       def submit_button(value, *args)
         options = args.extract_options!
         css_classes = ["btn"] << options.delete(:class) << args
@@ -15,6 +47,29 @@ module Viewaide
                     }.merge(options)
       end
 
+      # Generates a wrapper set for form inputs and labels
+      #
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <% set do %>words<% end %>
+      #   generates
+      #   <div class="text">words</div>
+      #
+      # @example
+      #   <% set :checkbox do %>words<% end %>
+      #   generates
+      #   <div class="checkbox">words</div>
+      #
+      # @example
+      #   <% set :id => "custom-id" do %>words<% end %>
+      #   generates
+      #   <div class="text" id="custom-id">words</div>
+      #
+      # @example
+      #   <% set :half do %>words<% end %>
+      #   generates
+      #   <div class="text span-12">words</div>
       def set(*args, &block)
         options = args.extract_options!
         css_classes = [] << options.delete(:class) << args
@@ -38,6 +93,48 @@ module Viewaide
         concat(html)
       end
 
+      # Generates a fieldset with legend
+      #
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <% fieldset do %>words<% end %>
+      #   generates
+      #   <fieldset>words</fieldset>
+      #
+      # @example
+      #   <% fieldset "User Information" do %>words<% end %>
+      #   generates
+      #   <fieldset>
+      #     <h3 class="legend">User Information</h3>
+      #   </fieldset>
+      #
+      # @example
+      #   <% fieldset "User Information", :hform do %>words<% end %>
+      #   generates
+      #   <fieldset class="hform">
+      #     <h3 class="legend">User Information</h3>
+      #   </fieldset>
+      #
+      # @example
+      #   <% fieldset "User Information", :hform, :legend => {:class => "lgnd", :id => "legend-id"} do %>
+      #     words
+      #   <% end %>
+      #   generates
+      #   <fieldset class="hform">
+      #     <h3 class="legend lgnd" id="legend-id">User Information</h3>
+      #     words
+      #   </fieldset>
+      #
+      # @example
+      #   <% fieldset "User Information", :hform, :id => "user-info" do %>
+      #     words
+      #   <% end %>
+      #   generates
+      #   <fieldset class="hform" id="user-info">
+      #     <h3 class="legend">User Information</h3>
+      #     words
+      #   </fieldset>
       def fieldset(*args, &block)
         options = args.extract_options!
         css_classes = [] << options.delete(:class) << args

data/lib/viewaide/helpers/grid_helper.rb

@@ -30,11 +30,13 @@ module Viewaide
       }.freeze
       MULTIPLE_FRACTIONS = MULTIPLES.keys.map {|key| key.to_s }.freeze
 
+      # force use of Easel-style classes
       def self.easel_grid!
         @@last_column = "col-last"
         @@column_prefix = "col"
       end
 
+      # force use of Blueprint-style classes (the default)
       def self.blueprint_grid!
         @@last_column = "last"
         @@column_prefix = "span"
@@ -42,15 +44,56 @@ module Viewaide
 
       blueprint_grid!
 
+      # @return [String] last column (based on Blueprint or Easel grid formats)
       def last_column
         @@last_column
       end
 
+      # Returns a div with the correct width-calculated class
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <% column do %>Full column<% end %>
+      #   generates
+      #   <div class="span-24">Full column</div>
+      #
+      # @example
+      #   <% column do %>
+      #     <% column :half do %>column<% end %>
+      #   <% end %>
+      #   generates
+      #   <div class="span-24">
+      #     <div class="span-12">column</div>
+      #   </div>
+      #
+      # @example
+      #   <% column :one_third do %>one third<% end %>
+      #   <% column :two_thirds, :last do %>two thirds<% end %>
+      #   generates
+      #   <div class="span-8">one third</div>
+      #   <div class="span-16 last">two thirds</div>
+      #
+      # @example
+      #   <% column :one_third, :custom, :id => "column" do %>words<% end %>
+      #   generates
+      #   <div class="span-8 custom" id="column">words</div>
       def column(*args, &block)
         @_viewaide_column_count ||= application_width
         col(*args, &block)
       end
 
+      # Wraps content in a container
+      # @param [Symbol] size size of the container
+      # @return [String]
+      # @example
+      #   <% container do %>content<% end %>
+      #   generates
+      #   <div class="container">content<% end %>
+      #
+      # @example
+      #   <% container :half do %>content<% end %>
+      #   generates
+      #   <div class="container span-12">content<% end %>
       def container(size=nil, *args, &block)
         opts = args.extract_options!
         opts.merge!(:suppress_col => true) if size.nil?

data/lib/viewaide/helpers/jquery_helper.rb

@@ -1,7 +1,28 @@
 module Viewaide
   module Helpers
     module JqueryHelper
-
+      # generates a script tag with the appropriate type,
+      # an anonymous function (assigning jQuery to $),
+      # and within a #ready callback
+      #
+      # @param [block] &block the block of text to wrap
+      # @return [String]
+      # @example
+      #   <% document_ready do %>
+      #     $("a[rel=external]").live(function() {
+      #       $(this).attr({target: "_blank"});
+      #     });
+      #   <% end %>
+      #   generates
+      #   <script type="text/javascript">
+      #     (function($) {
+      #       $(document).ready(function() {
+      #         $("a[rel=external]").live(function() {
+      #           $(this).attr({target: "_blank"});
+      #         });
+      #       });
+      #     })(jQuery);
+      #   </script>
       def document_ready(&block)
         html = content_tag :script, :type => "text/javascript" do
           %(

data/lib/viewaide/helpers/link_helper.rb

@@ -2,6 +2,21 @@ module Viewaide
   module Helpers
     module LinkHelper
 
+      # Generates a link that's able to be styled like a button.
+      # This functions exactly like Rails' #link_to but wraps the link text
+      # in a span and assigns a class of "btn"
+      #
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <%= link_button "Text", root_path %>
+      #   generates
+      #   <a href="/" class="btn"><span>Text</span></a>
+      #
+      # @example
+      #   <%= link_button "Text", root_path, :class => "extra" %>
+      #   generates
+      #   <a href="/" class="btn extra"><span>Text</span></a>
       def link_button(*args, &block)
         doc = Hpricot(link_to(*args, &block))
         doc.at("a").inner_html = "<span>#{doc.at("a").inner_html}</span>"
@@ -9,6 +24,25 @@ module Viewaide
         doc.to_html
       end
 
+      # Generates a link to an email address.
+      # This functions exactly like Rails' #link_to but changes the href to include "mailto:"
+      # @param [String] email_address the email address for the link
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <%= link_to_email "abc@def.com" %>
+      #   generates
+      #   <a href="mailto:abc@def.com">abc@def.com</a>
+      #
+      # @example
+      #   <%= link_to_email "abc@def.com", "John Doe" %>
+      #   generates
+      #   <a href="mailto:abc@def.com">John Doe</a>
+      #
+      # @example
+      #   <%= link_to_email "abc@def.com", "John Doe", :class => "extra" %>
+      #   generates
+      #   <a href="mailto:abc@def.com" class="extra">John Doe</a>
       def link_to_email(email_address, *args)
         options = args.extract_options!
         link = args.first.is_a?(String) ? h(args.first) : email_address

data/lib/viewaide/helpers/message_helper.rb

@@ -1,7 +1,19 @@
 module Viewaide
   module Helpers
     module MessageHelper
-
+      # Generates paragraphs, each containing the values of the hash passed
+      # @param [Hash] messages a hash (#flash, especially) that will render the values in separate paragraphs
+      # @return [String]
+      # @example
+      #   <%= messages(:notice => "Your record was saved") %>
+      #   generates
+      #   <p class="notice box single-line">Your record was saved</p>
+      #
+      # @example
+      #   <%= messages(:notice => "Your record was saved", :error => "Something happened!") %>
+      #   generates
+      #   <p class="notice box single-line">Your record was saved</p>
+      #   <p class="error box single-line">Something happened!</p>
       def messages(messages, options = {})
         except_keys = [options[:except]].flatten.compact
         only_keys   = [options[:only]].flatten.compact

data/lib/viewaide/helpers/navigation_helper.rb

@@ -1,6 +1,23 @@
 module Viewaide
   module Helpers
     module NavigationHelper
+      # Generates a <li> and <a> for site navigation
+      # @param [String] name the anchor text
+      # @param [String] path the URL of the anchor
+      # @param [Hash] options options hash for #link_to
+      # @param [Hash] li_options options hash for #content_tag
+      # @example
+      #   <%= tab "Home", root_path %>
+      #   generates
+      #   <li><a href="/">Home</a></li>
+      #
+      #   <%= tab "Home", root_path, :compare => (controller.action_name == "show") %>
+      #   generates
+      #   <li class="active"><a href="/">Home</a></li>
+      #
+      #   <%= tab "Home", root_path, {:class => "a"}, {:class => "li"} %>
+      #   generates
+      #   <li class="li"><a href="/" class="a">Home</a></li>
       def tab(name, path, options = {}, li_options = {})
         opts = parse_tab_options(name, li_options)
 

data/lib/viewaide/helpers/structure_helper.rb

@@ -2,6 +2,21 @@ module Viewaide
   module Helpers
     module StructureHelper
 
+      # Generate a blockquote
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <% blockquote do %>Quoted text<% end %>
+      #   generates
+      #   <blockquote>Quoted text</blockquote>
+      #
+      # @example
+      #   <% blockquote :author => "W. Shakespeare" do %>All the world's a stage<% end %>
+      #   generates
+      #   <div class="quote-cited">
+      #     <blockquote>All the world's a stage</blockquote>
+      #     <cite>W. Shakespeare</cite>
+      #   </div>
       def blockquote(*args, &block)
         options = args.extract_options!
         author = options.delete(:author)
@@ -21,6 +36,26 @@ module Viewaide
         concat(html)
       end
 
+      # Allows assignment of <body> attributes.
+      # The body (when accepting a block) should be used in your application's layout
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <% body do %>body goes here<% end %>
+      #   generates
+      #   <body>body goes here</body>
+      #
+      # @example
+      #   <% body :home, "logged-in", :id => "application" do %>body goes here<% end %>
+      #   generates
+      #   <body class="home logged-in" id="application">body goes here</body>
+      #
+      # @example
+      #   <% body :home, "logged-in" %> # within an ERB template
+      #   <% body :id => "application" %> # within a different ERB template
+      #   <% body do %>body goes here<% end %> # within application layout
+      #   generates
+      #   <body class="home logged-in" id="application">body goes here</body>
       def body(*args)
         options = args.extract_options!
         @_page_body_attributes ||= {}

data/lib/viewaide/helpers/table_helper.rb

@@ -2,6 +2,23 @@ module Viewaide
   module Helpers
     module TableHelper
 
+      # Generates <tr> elements with alternating classes
+      # @param [Hash] options options passed for classes to cycle through
+      # @return [String]
+      # @example
+      #   <% zebra_row do %>no class<% end %><% zebra_row do %>alt class<% end %>
+      #   generates
+      #   <tr>no class</tr>
+      #   <tr class="alt">alt class</tr>
+      #
+      # @example
+      #   <% (colors = %w(red white blue)).each do |color| %>
+      #     <% zebra_row :cycle_list => colors do %>the color <%= color %><% end %>
+      #   <% end %>
+      #   generates
+      #   <tr class="red">the color red</tr>
+      #   <tr class="white">the color white</tr>
+      #   <tr class="blue">the color blue</tr>
       def zebra_row(options = {}, &block)
         cycle_list = options.delete(:cycle_list) || [nil, "alt"]
         css_classes = [cycle(*cycle_list)] << options.delete(:class)
@@ -13,6 +30,25 @@ module Viewaide
         concat(html)
       end
 
+      # Generates a <table> and appropriate <thead> elements
+      # @param [*Args]
+      # @return [String]
+      # @example
+      #   <% recordset :headers => ["First Column", "Second Column"] do %>
+      #     <tbody>
+      #     </tbody>
+      #   <% end %>
+      #   generates
+      #   <table class="recordset" cellspacing="0">
+      #     <thead>
+      #       <tr>
+      #         <th class="first">First Column</th>
+      #         <th class="last">Second Column</th>
+      #       </tr>
+      #     </thead>
+      #     <tbody>
+      #     </tbody>
+      #   </table>
       def recordset(*args, &block)
         options = args.extract_options!
         options[:table] ||= {}

data/lib/viewaide/rails_partial_caching.rb

@@ -32,6 +32,8 @@ module Viewaide
     end
 
     module InstanceMethods
+      # Clears viewaide session counts for non-XHR requests
+      # @return [nil]
       def clear_viewaide_cache
         session[:viewaide_cached_column_counts] = nil unless request.xhr?
       end

data/viewaide.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{viewaide}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Clayton"]
-  s.date = %q{2010-01-09}
+  s.date = %q{2010-01-12}
   s.description = %q{Making your views easier}
   s.email = %q{joshua.clayton@gmail.com}
   s.extra_rdoc_files = [
@@ -74,16 +74,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<actionview>, [">= 2.1.0"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 2.1.0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
       s.add_runtime_dependency(%q<hpricot>, [">= 0.8.1"])
     else
-      s.add_dependency(%q<actionview>, [">= 2.1.0"])
+      s.add_dependency(%q<actionpack>, [">= 2.1.0"])
       s.add_dependency(%q<activesupport>, [">= 2.1.0"])
       s.add_dependency(%q<hpricot>, [">= 0.8.1"])
     end
   else
-    s.add_dependency(%q<actionview>, [">= 2.1.0"])
+    s.add_dependency(%q<actionpack>, [">= 2.1.0"])
     s.add_dependency(%q<activesupport>, [">= 2.1.0"])
     s.add_dependency(%q<hpricot>, [">= 0.8.1"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: viewaide
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Joshua Clayton
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 -05:00
+date: 2010-01-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: actionview
+  name: actionpack
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement