cheveret 1.0.0 → 1.1.0

data/Rakefile

@@ -10,7 +10,7 @@ begin
 application is not very DRY even for the simpler of cases. Cheveret allows you to more
 clearly separate logic and templating and reduce the amount of code in your views.}
     gem.email = "aulankz@gmail.com"
-    gem.homepage = "http://github.com/lankz/cheveret"
+    gem.homepage = "http://github.com/ratecity/cheveret"
     gem.authors = ["Ben Caldwell"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/cheveret.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cheveret}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Caldwell"]
-  s.date = %q{2010-09-17}
+  s.date = %q{2010-09-20}
   s.description = %q{Generating HTML tables of data in the views of your Rails
 application is not very DRY even for the simpler of cases. Cheveret allows you to more
 clearly separate logic and templating and reduce the amount of code in your views.}
@@ -33,7 +33,7 @@ clearly separate logic and templating and reduce the amount of code in your view
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/lankz/cheveret}
+  s.homepage = %q{http://github.com/ratecity/cheveret}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/lib/cheveret.rb

@@ -113,14 +113,14 @@ module Cheveret
       self.visible = true
     end
 
-    # hides the column, prevents it from being rendered in the table
-    # helper for setting :visible => false
+    # hides the column, prevents it from being rendered in the table. acts as a
+    # helper for setting <tt>:visible => false</tt>
     def hide
       self.visible = false
     end
 
-    # returns true for columns that have :visible => true or #show called on them
-    # columns are visible by default
+    # returns +true+ for columns that have <tt>:visible => true</tt> or #show called
+    # on them. columns are visible by default
     def visible?
       self.visible != false
     end
@@ -129,9 +129,14 @@ module Cheveret
       self.flexible != false
     end
 
+    # returns +true+ unless a column has explicitly set <tt>:sortable => false</tt>
+    def sortable?
+      self.sortable != false
+    end
+
     def label
       case @config.label
-      when nil then @name.to_str.humanize # todo: support i18n for column labels
+      when nil then @name.to_s.humanize # todo: support i18n for column labels
       when false then nil
       else @config.label
       end
@@ -147,7 +152,25 @@ module Cheveret
   end
 
   module Helpers
-    # renders a table for a collection of objects
+    # view helper that facilities the rendering of tables for a collection of similar
+    # objects
+    #
+    # behaves much in the same way as Rails +form+for+ helper in that it takes a proc
+    # and provides access to a table builder object. the entire block is captured, so
+    # additional markup can be output at any point
+    #
+    #  <% table_for @books, :width => 480 do |t| %>
+    #    <% t.columns :title, :author, :publisher, :price %>
+    #    <% t.header %>
+    #    <% t.body %>
+    #  <% end %>
+    #
+    # === Options
+    # * <tt>:width</tt> - the total width of the table in pixels
+    # * <tt>:html</tt>  - a hash of html attributes used for the form container
+    # * <tt>:url</tt>   - used to generate urls for sortable columns
+    #
+    # === Examples
     def table_for(collection, options={}, &block)
       builder = options.delete(:builder) || ActionView::Base.default_table_builder
 
@@ -155,16 +178,17 @@ module Cheveret
       builder.render(Table.new, self, options, &block)
     end
 
+    # the default #TableBuilder class generates an HTML table using div tags
     class TableBuilder
       extend ::Forwardable
       def_delegators :@table, :columns
 
       def self.render(table, template, options={}, &block)
-        # todo: merge container element with :html passed into table_for
-        attrs = { :class => "table",
-                  :style => "width: #{options[:width]}px;" }
+        html_attrs = options.delete(:html) || {}
+        html_attrs.merge!({ :class => "table",
+                            :style => "width: #{options[:width]}px;" })
 
-        template.content_tag(:div, attrs) do
+        template.content_tag(:div, html_attrs) do
           template.capture(self.new(table, template, options), &block)
         end
       end
@@ -174,20 +198,22 @@ module Cheveret
 
         @width = options.delete(:width)
         @collection = options.delete(:collection)
+        @url = options.delete(:url)
       end
 
       def header(*args, &block)
         @table.resize!(@width)
 
-        row = @template.content_tag(:div, :class => "tr") do
+        row = content_tag(:div, :class => "tr") do
           map_columns(:th) do |column|
             # todo: prevent output of empty <a> tag for header label
             output   = nil_capture(column, &block) if block_given?
-            output ||= @template.content_tag(:a, column.label)
+            output ||= sort_tag(column) if column.sortable?
+            output ||= content_tag(:span, column.label)
           end
         end
 
-        @template.content_tag(:div, row, :class => "thead")
+        content_tag(:div, row, :class => "thead")
       end
 
       def body(&block)
@@ -197,15 +223,15 @@ module Cheveret
         rows = @collection.map do |object|
           object_name = object.class.to_s.split('::').last.underscore || ''
           klass = [ 'tr', object_name, (alt = !alt) ? nil : 'alt' ].compact
-          @template.content_tag(:div, :class => klass.join(' ')) do
+          content_tag(:div, :class => klass.join(' ')) do
             map_columns(:td) do |column|
               output   = nil_capture(column, object, &block) if block_given?
-              output ||= @template.content_tag(:span, column.data(object))
+              output ||= content_tag(:span, column.data(object))
             end
           end
         end
 
-        @template.content_tag(:div, rows.join, :class => "tbody")
+        content_tag(:div, rows.join, :class => "tbody")
       end
 
     private
@@ -215,16 +241,38 @@ module Cheveret
           attrs = { :class => [type, column.name].join(' '),
                     :style => "width: #{column.width}px;" }
 
-          @template.content_tag(:div, attrs) do
+          content_tag(:div, attrs) do
             yield(column)
           end if column.visible?
         end
       end
 
       def nil_capture(*args, &block) #:nodoc:
-        custom = @template.capture(*args, &block).strip
+        custom = capture(*args, &block).strip
         output = custom.empty? ? nil : custom
       end
+
+      def sort_tag(column) #:nodoc:
+        return nil unless column.sortable?
+
+        klass = [ 'sortable' ]
+        sort  = column.name
+        order = "asc"
+
+        if params[:sort].to_s == column.name.to_s
+          klass << [ 'sorted', params[:order] ]
+          order = "desc" if params[:order] == "asc"
+        end
+
+        content_tag(:a, column.label, {
+          :class => klass.flatten.join(' '),
+          :href => url_for(@url.merge({ :sort => sort, :order => order })) })
+      end
+
+      def method_missing(method_name, *args, &block) #:nodoc:
+        return @template.send(method_name, *args, &block) if @template.respond_to?(method_name)
+        super
+      end
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cheveret
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ben Caldwell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-17 00:00:00 +10:00
+date: 2010-09-20 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,7 +61,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/lankz/cheveret
+homepage: http://github.com/ratecity/cheveret
 licenses: []
 
 post_install_message: