tableficate 0.2.1 → 0.3.0

data/README.markdown

@@ -9,7 +9,7 @@ This project follows [Semantic Versioning](http://semver.org/).
 
 If you're using Bundler, add this to your Gemfile:
 
-    gem 'tableficate', '~>0.2.0'
+    gem 'tableficate', '~>0.3.0'
 
 ## Support
 
@@ -119,7 +119,9 @@ The theme can then be applied to a table.
       ...
     <% end %>
 
-## Changes Needed to Upgrade From 0.1
+## Changes Needed to Upgrade From 0.2
 
-1. The filter functions used in the `table_for` call have been completely changed. They will need to be rewritten in all of your calls.
-2. New filter partials have been added to accomodate the new filter types that are available. If you have custom themes they will need to be updated. This can be done by first moving "_column_header.html.erb" to "_header.html.erb", "filters/_input_field.html.erb" to "filters/_input.html.erb" and "filters/_input_field_range.html.erb" to "filters/_input_range.html.erb". Then rerun `rails generate tableficate:theme NAME`. This will not overwrite files you have altered for your new theme.
+1. HTML attributes passed to `table_for` will no longer be passed via the `:html` option. Now all unrecognized options are passed as HTML attributes. This is more consistent with the other functions.
+2. In custom templates the `options` attribute is no longer available on all objects that had it. Any options specific to the object have been turned into attributes. For example, `label_options` is now an attribute on filters and `collection` is now an attribute on select, radio and check box filters. All other options will be used as HTML attributes and can be found in the new `attrs` attribute.
+3. The `_table.html.erb` theme partial has been renamed to `_table_for.html.erb`. The `_table.html.erb` file has been repurposed for the new `tableficate_table_tag` helper. Another helper, `tableficate_filter_form_tag`, has replaced the filter form in `_table_for.html.erb`. A new partial, `filters/_form.html.erb` was created for this new helper. The `_header.html.erb` and `_data.html.erb` partials have been updated so that `th` and `td` tags can accept attributes. Running `rails generate tableficate:theme NAME` for an existing theme will provide an interactive means of updating your existing theme. Additionally, if a partial is missing it will now be retrieved from the standard theme. This means you can optionally delete any partials that you have not altered. This should make future upgrades easier.
+4. When creating custom themes the `tableficate_radio_tags` and `tableficate_check_box_tags` no longer accept blocks to format the output. Instead, they now use templates called "filters/_radio_choice.html.erb" and "filters/_check_box_choice.html.erb" respectively. All you have to do is move the block code into the new templates.

data/app/views/tableficate/_data.html.erb

@@ -1 +1,7 @@
-<td><%= column.value(row) %></td>
+<% attrs = column.cell_attrs.dup %>
+<% attrs.each do |key, value| %>
+  <% attrs[key] = value.call(row) if attrs[key].is_a?(Proc) %>
+<% end %>
+<%= content_tag(:td, attrs) do %>
+  <%= column.value(row) %>
+<% end %>

data/app/views/tableficate/_header.html.erb

@@ -1,8 +1,8 @@
-<th>
+<%= content_tag(:th, column.header_attrs) do %>
   <%= column.header %>
   <% table_params = (params[column.table.as] || {}) %>
   <% if column.show_sort? %>
     <%= link_to 'A', url_for(params.merge(column.table.as => table_params.merge({sort: column.name.to_s, dir: 'asc'}))) %><% if column.is_sorted?('asc') %>*<% end %>
     <%= link_to 'D', url_for(params.merge(column.table.as => table_params.merge({sort: column.name.to_s, dir: 'desc'}))) %><% if column.is_sorted?('desc') %>*<% end %>
   <% end %>
-</th>
+<% end %>

data/app/views/tableficate/_table.html.erb

@@ -1,26 +1,15 @@
-<% if table.filters.any? %>
-  <%= form_tag('', method: :get, novalidate: 'novalidate') do %>
-    <% if params[table.as] and params[table.as][:sort] %>
-      <%= hidden_field_tag("#{table.as}[sort]", params[table.as][:sort]) %>
-    <% end %>
-    <% if params[table.as] and params[table.as][:dir] %>
-      <%= hidden_field_tag("#{table.as}[dir]", params[table.as][:dir]) %>
-    <% end %>
-    <% table.filters.each do |filter| %>
-      <%= tableficate_filter_tag(filter) %>
+<%= content_tag(:table, table.attrs) do %>
+  <% if table.caption %>
+    <%= content_tag(:caption, table.caption.value, table.caption.attrs) %>
+  <% end %>
+  <% if table.columns.any?{|column| column.attrs.present?} %>
+    <% table.columns.chunk{|column| column.attrs}.each do |column_group| %>
+      <% span = column_group.last.length %>
+      <% attrs = column_group.first %>
+      <% attrs.merge!(span: span) if span > 1 %>
+      <%= tag(:col, attrs) %>
     <% end %>
-
-    <%= submit_tag('Filter') %>
   <% end %>
-<% end %>
-
-<% if defined? ::Kaminari %>
-  <%= paginate(table.rows, param_name: "#{table.as}_page") %>
-<% elsif defined? ::WillPaginate %>
-  <%= will_paginate(table.rows, param_name: "#{table.as}_page") %>
-<% end %>
-
-<%= content_tag(:table, table.options[:html]) do %>
   <thead>
     <tr>
       <% table.columns.each do |column| %>
@@ -29,8 +18,12 @@
     </tr>
   </thead>
   <tbody>
-    <% table.rows.each do |row| %>
-      <%= tableficate_row_tag(row, table.columns) %>
+    <% if table.rows.size > 0 %>
+      <% table.rows.each do |row| %>
+        <%= tableficate_row_tag(row, table.columns) %>
+      <% end %>
+    <% elsif table.empty and table.empty.value.present? %>
+      <tr><%= content_tag(:td, table.empty.value, table.empty.attrs) %></tr>
     <% end %>
   </tbody>
 <% end %>

data/app/views/tableficate/_table_for.html.erb

@@ -0,0 +1,9 @@
+<%= tableficate_filter_form_tag(table) %>
+
+<% if defined? ::Kaminari %>
+  <%= paginate(table.rows, param_name: "#{table.as}_page") %>
+<% elsif defined? ::WillPaginate %>
+  <%= will_paginate(table.rows, param_name: "#{table.as}_page") %>
+<% end %>
+
+<%= tableficate_table_tag(table) %>

data/app/views/tableficate/filters/_check_box_choice.html.erb

@@ -0,0 +1,3 @@
+<%= check_box_tag("#{filter.field_name}[#{choice.value}]", choice.value, choice.checked?, choice.attrs.reverse_merge(name: "#{filter.field_name}[]")) %>
+<%= label_tag("#{filter.field_name}[#{choice.value}]", choice.name) %>
+<br/>

data/app/views/tableficate/filters/_form.html.erb

@@ -0,0 +1,16 @@
+<% if table.filters.any? %>
+  <%= form_tag('', method: :get, novalidate: 'novalidate') do %>
+    <% if params[table.as] and params[table.as][:sort] %>
+      <%= hidden_field_tag("#{table.as}[sort]", params[table.as][:sort]) %>
+    <% end %>
+    <% if params[table.as] and params[table.as][:dir] %>
+      <%= hidden_field_tag("#{table.as}[dir]", params[table.as][:dir]) %>
+    <% end %>
+
+    <% table.filters.each do |filter| %>
+      <%= tableficate_filter_tag(filter) %>
+    <% end %>
+
+    <%= submit_tag('Filter') %>
+  <% end %>
+<% end %>

data/app/views/tableficate/filters/_radio_choice.html.erb

@@ -0,0 +1,3 @@
+<%= radio_button_tag(filter.field_name, choice.value, choice.checked?, choice.attrs) %>
+<%= label_tag("#{filter.field_name}[#{choice.value}]", choice.name) %>
+<br/>

data/changelog.markdown

@@ -1,3 +1,20 @@
+## 0.3.0
+ * tables no longer take the :html option, all non-recognized options are passed through as HTML attributes
+ * The `options` attribute on a variety of objects has been removed. It has been replaced with specialized functions such as `label_options` and `collection` with all unrecognized options placed into the `attrs` attribute.
+ * adding `tableficate_table_tag` helper
+ * adding `tableficate_filter_form_tag` helper
+ * adding support for captions
+ * missing theme partials will default to the standard partial
+ * tableficate:theme generator now takes an optional `PARTIAL` arg to specify one file
+ * `actions` now takes options just like `column`
+ * `column` now takes a `header_attrs` option to provide attributes for the `th`
+ * `column` now takes a `cell_attrs` option to provide attributes for every `td` in the column, a proc can be passed in place of a string for attributes to customize on a per cell basis
+ * `column` now places all unrecognized options into the `attrs` attribute which is used on a `col` tag
+ * adding `empty` to display a message when a table has no data
+ * input types are automatically figured out by label name and DB column type
+ * `tableficate_radio_tags` and `tableficate_check_box_tags` use partials now rather than block formatting
+ * dates and date ranges used against datetime and timestamp columns will automatically work as expected (i.e. 01/01/2011 will get everything between 00:00:00 and 23:59:59 for that day)
+
 ## 0.2.1
  * fix table generator to provide `scope` the proper argument and correct documentation
 

data/lib/generators/tableficate/theme/theme_generator.rb

@@ -6,10 +6,26 @@ module Tableficate
 
     source_root File.expand_path("../../../../../#{VIEW_PATH}", __FILE__)
 
+    argument :partial, required: false
+
     def create_theme
       empty_directory(VIEW_PATH)
 
-      directory('', "#{VIEW_PATH}/#{file_name}")
+      if partial
+        if partial =~ /\//
+          partial =~ /^(.*)\/(.*)$/
+          extra_dirs   = $1
+          partial_name = $2
+
+          empty_directory("#{VIEW_PATH}/#{file_name}/#{extra_dirs}")
+
+          copy_file("#{extra_dirs}/_#{partial_name}.html.erb", "#{VIEW_PATH}/#{file_name}/#{extra_dirs}/_#{partial_name}.html.erb")
+        else
+          copy_file("_#{partial}.html.erb", "#{VIEW_PATH}/#{file_name}/_#{partial}.html.erb")
+        end
+      else
+        directory('', "#{VIEW_PATH}/#{file_name}")
+      end
     end
   end
 end

data/lib/tableficate.rb

@@ -4,9 +4,12 @@ require 'tableficate/utils'
 require 'tableficate/finder'
 require 'tableficate/column'
 require 'tableficate/action_column'
+require 'tableficate/caption'
+require 'tableficate/empty'
 require 'tableficate/filters/collection'
 require 'tableficate/filters/choice'
 require 'tableficate/filters/base'
+require 'tableficate/filters/collection_base'
 require 'tableficate/filters/input'
 require 'tableficate/filters/input_range'
 require 'tableficate/filters/select'

data/lib/tableficate/action_column.rb

@@ -1,7 +1,7 @@
 module Tableficate
   class ActionColumn < Column
-    def initialize(table, &block)
-      super(table, '', {}, &block)
+    def initialize(table, options = {}, &block)
+      super(table, '', options, &block)
     end
 
     def show_sort?

data/lib/tableficate/caption.rb

@@ -0,0 +1,29 @@
+module Tableficate
+  class Caption
+    attr_reader :attrs
+
+    def initialize(*args, &block)
+      if block_given?
+        @attrs   = args.first || {}
+        @content = block
+      else
+        @content = args[0]
+        @attrs   = args[1] || {}
+      end
+    end
+
+    def value
+      if @content.is_a?(String)
+        @content
+      else
+        output = @content.call
+        if output.is_a?(ActionView::OutputBuffer)
+          ''
+        else
+          output = output.html_safe if output.respond_to? :html_safe
+          output
+        end
+      end
+    end
+  end
+end

data/lib/tableficate/column.rb

@@ -1,14 +1,20 @@
 module Tableficate
   class Column
-    attr_reader :name, :header, :table
+    attr_reader :name, :header, :table, :header_attrs, :cell_attrs, :attrs
 
     def initialize(table, name, options = {}, &block)
-      @table   = table
-      @name    = name
-      @options = options
-      @block   = block
+      @table = table
+      @name  = name
+      @block = block
 
-      @header = @options.delete(:header) || name.to_s.titleize
+      @header       = options.delete(:header) || name.to_s.titleize
+      @header_attrs = options.delete(:header_attrs) || {}
+
+      @cell_attrs = options.delete(:cell_attrs) || {}
+
+      @show_sort = options.delete(:show_sort) || false
+
+      @attrs = options
     end
 
     def value(row)
@@ -26,7 +32,7 @@ module Tableficate
     end
 
     def show_sort?
-      !!@options[:show_sort]
+      @show_sort
     end
 
     def is_sorted?(dir = nil)

data/lib/tableficate/empty.rb

@@ -0,0 +1,34 @@
+module Tableficate
+  class Empty
+    def initialize(table, *args, &block)
+      @table = table
+
+      if block_given?
+        @attrs   = args.first || {}
+        @content = block
+      else
+        @content = args[0]
+        @attrs   = args[1] || {}
+      end
+    end
+
+    def value
+      if @content.is_a?(String)
+        @content
+      else
+        output = @content.call
+        if output.is_a?(ActionView::OutputBuffer)
+          ''
+        else
+          output = output.html_safe if output.respond_to? :html_safe
+          output
+        end
+      end
+    end
+
+    def attrs
+      @attrs[:colspan] = @table.columns.length
+      @attrs
+    end
+  end
+end

data/lib/tableficate/filters/base.rb

@@ -1,15 +1,17 @@
 module Tableficate
   module Filter
     class Base
-      attr_reader :name, :label, :options, :template, :table, :field_name
+      attr_reader :name, :label, :attrs, :template, :table, :field_name, :label_options
 
       def initialize(table, name, options = {})
-        @table   = table
-        @name    = name
-        @options = options
+        @table = table
+        @name  = name
+
+        @label         = options.delete(:label) || table.columns.detect{|column| column.name == @name}.try(:header) || name.to_s.titleize
+        @label_options = options.delete(:label_options) || {}
+        @attrs         = options
 
         @template   = 'filters/' + self.class.name.demodulize.underscore
-        @label      = @options.delete(:label) || table.columns.detect{|column| column.name == @name}.try(:header) || name.to_s.titleize
         @field_name = "#{table.as}[filter][#{@name}]"
       end
 

data/lib/tableficate/filters/check_box.rb

@@ -1,6 +1,6 @@
 module Tableficate
   module Filter
-    class CheckBox < Base
+    class CheckBox < CollectionBase
     end
   end
 end

data/lib/tableficate/filters/choice.rb

@@ -1,7 +1,7 @@
 module Tableficate
   module Filter
     class Choice
-      attr_reader :name, :value, :options
+      attr_reader :name, :value, :attrs
 
       def initialize(name, value, options = {})
         @name  = name
@@ -11,7 +11,7 @@ module Tableficate
         options.delete(:selected)
         options.delete(:checked)
 
-        @options = options
+        @attrs = options
       end
 
       def selected?

data/lib/tableficate/filters/collection_base.rb

@@ -0,0 +1,13 @@
+module Tableficate
+  module Filter
+    class CollectionBase < Base
+      attr_reader :collection
+
+      def initialize(table, name, options = {})
+        @collection = options.delete(:collection) || []
+
+        super(table, name, options)
+      end
+    end
+  end
+end

data/lib/tableficate/filters/input.rb

@@ -4,8 +4,8 @@ module Tableficate
       def initialize(table, name, options = {})
         super(table, name, options)
 
-        new_template = "filters/input_#{options[:type]}"
-        @template = new_template if table.template.lookup_context.exists?(Tableficate::Utils::template_path(new_template, table.options[:theme]), [], true)
+        new_partial = "filters/input_#{@attrs[:type]}"
+        @template = new_partial if table.template.lookup_context.exists?(Tableficate::Utils::template_path(table.template, new_partial, table.theme), [], true)
       end
     end
   end

data/lib/tableficate/filters/input_range.rb

@@ -41,16 +41,16 @@ module Tableficate
 
         super(table, name, options)
 
-        start_options.reverse_merge!(@options)
-        start_options.reverse_merge!(label: self.label)
-        stop_options.reverse_merge!(@options)
-        stop_options.reverse_merge!(label: self.label)
+        start_options.reverse_merge!(@attrs)
+        start_options.reverse_merge!(label: self.label, label_options: self.label_options)
+        stop_options.reverse_merge!(@attrs)
+        stop_options.reverse_merge!(label: self.label, label_options: self.label_options)
 
         @start = InputStart.new(table, name, start_options)
         @stop  = InputStop.new(table, name, stop_options)
 
-        new_template = "filters/input_range_#{options[:type]}"
-        @template = new_template if table.template.lookup_context.exists?(Tableficate::Utils::template_path(new_template, table.options[:theme]), [], true)
+        new_partial = "filters/input_range_#{@attrs[:type]}"
+        @template = new_partial if table.template.lookup_context.exists?(Tableficate::Utils::template_path(table.template, new_partial, table.theme), [], true)
       end
     end
   end

data/lib/tableficate/filters/radio.rb

@@ -1,6 +1,6 @@
 module Tableficate
   module Filter
-    class Radio < Base
+    class Radio < CollectionBase
     end
   end
 end

data/lib/tableficate/filters/select.rb

@@ -1,6 +1,6 @@
 module Tableficate
   module Filter
-    class Select < Base
+    class Select < CollectionBase
     end
   end
 end

data/lib/tableficate/filters/select_range.rb

@@ -41,10 +41,10 @@ module Tableficate
 
         super(table, name, options)
 
-        start_options.reverse_merge!(@options)
-        start_options.reverse_merge!(label: self.label)
-        stop_options.reverse_merge!(@options)
-        stop_options.reverse_merge!(label: self.label)
+        start_options.reverse_merge!(@attrs)
+        start_options.reverse_merge!(label: self.label, label_options: self.label_options)
+        stop_options.reverse_merge!(@attrs)
+        stop_options.reverse_merge!(label: self.label, label_options: self.label_options)
 
         @start = SelectStart.new(table, name, start_options)
         @stop  = SelectStop.new(table, name, stop_options)

data/lib/tableficate/finder.rb

@@ -5,42 +5,74 @@ module Tableficate
       raise Tableficate::MissingScope unless scope.new.kind_of?(ActiveRecord::Base)
 
       # filtering
-      if params
-        if params[:filter]
-          params[:filter].each do |name, value|
-            next if value.blank? or (value.is_a?(Hash) and value.all?{|key, value| value.blank?})
+      if params and params[:filter]
+        params[:filter].each do |name, value|
+          next if value.blank? or (value.is_a?(Hash) and value.all?{|key, value| value.blank?})
 
-            name = name.to_sym
-            value.strip! if value.is_a?(String)
+          # cleanup filter params
+          name = name.to_sym
+          if value.is_a?(Array)
+            value.map!{|v| prepare_value(v)}
+          elsif value.is_a?(Hash)
+            value.each do |k, v|
+              value[k] = prepare_value(v)
+            end
+          else
+            value = prepare_value(value)
+          end
 
-            if @filter and @filter[name]
-              if @filter[name].is_a?(Proc)
-                scope = @filter[name].call(value, scope)
-              elsif value.is_a?(String)
-                value = "%#{value}%" if @filter[name][:match] == 'contains'
+          # convert dates, datetimes, and timestamps to Ruby objects and account for date filtering on datetime type columns
+          case Tableficate::Utils::find_column_type(scope, name)
+          when :date
+            value = value.to_date
+          when :datetime, :timestamp
+            if value.is_a?(Hash)
+              # if it looks like it's only dates
+              if value[:start].gsub(/\D/, '').length <= 8 and value[:stop].gsub(/\D/, '').length <= 8
+                value = {start: Time.zone.parse(value[:start]), stop: Time.zone.parse(value[:stop]).advance(hours: 23, minutes: 59, seconds: 59)}
+              else
+                value[:start] = Time.zone.parse(value[:start])
+                value[:stop]  = Time.zone.parse(value[:stop])
+              end
+            elsif value.is_a?(String)
+              # if it looks like it's only a date
+              if value.gsub(/\D/, '').length <= 8
+                value = Time.zone.parse(value)
+                value = {start: value, stop: value.advance(hours: 23, minutes: 59, seconds: 59)}
+              else
+                value = Time.zone.parse(value)
+              end
+            end
+          end
 
-                scope = scope.where(["#{get_full_column_name(@filter[name][:field])} LIKE ?", value])
-              elsif value.is_a?(Array)
-                full_column_name = get_full_column_name(@filter[name][:field])
+          # attach the filter
+          if @filter and @filter[name]
+            if @filter[name].is_a?(Proc)
+              scope = @filter[name].call(value, scope)
+            elsif value.is_a?(Array)
+              full_column_name = get_full_column_name(@filter[name][:field])
 
-                if @filter[name][:match] == 'contains'
-                  scope = scope.where([
-                    Array.new(value.size, "#{full_column_name} LIKE ?").join(' OR '),
-                    *value.map{|v| "%#{v}%"}
-                  ])
-                else
-                  scope = scope.where(["#{full_column_name} IN(?)", value])
-                end
-              elsif value.is_a?(Hash)
-                scope = scope.where(["#{get_full_column_name(@filter[name][:field])} BETWEEN :start AND :stop", value])
+              if @filter[name][:match] == 'contains'
+                scope = scope.where([
+                  Array.new(value.size, "#{full_column_name} LIKE ?").join(' OR '),
+                  *value.map{|v| "%#{v}%"}
+                ])
+              else
+                scope = scope.where(["#{full_column_name} IN(?)", value])
               end
-            elsif value.is_a?(Array)
-              scope = scope.where(["#{get_full_column_name(name.to_s.gsub(/\W/, ''))} IN(?)", value])
             elsif value.is_a?(Hash)
-              scope = scope.where(["#{get_full_column_name(name.to_s.gsub(/\W/, ''))} BETWEEN :start AND :stop", value])
+              scope = scope.where(["#{get_full_column_name(@filter[name][:field])} BETWEEN :start AND :stop", value])
             else
-              scope = scope.where(["#{get_full_column_name(name.to_s.gsub(/\W/, ''))} LIKE ?", value])
+              value = "%#{value}%" if @filter[name][:match] == 'contains'
+
+              scope = scope.where(["#{get_full_column_name(@filter[name][:field])} LIKE ?", value])
             end
+          elsif value.is_a?(Array)
+            scope = scope.where(["#{get_full_column_name(name.to_s.gsub(/\W/, ''))} IN(?)", value])
+          elsif value.is_a?(Hash)
+            scope = scope.where(["#{get_full_column_name(name.to_s.gsub(/\W/, ''))} BETWEEN :start AND :stop", value])
+          else
+            scope = scope.where(["#{get_full_column_name(name.to_s.gsub(/\W/, ''))} LIKE ?", value])
           end
         end
       end
@@ -61,6 +93,8 @@ module Tableficate
         sorting[:dir]    = ['asc', 'desc'].include?(dir) ? dir : 'asc'
       end
       scope.tableficate_add_data(:current_sort, sorting)
+      filters_with_field = @filter ? @filter.select{|name, options| not options.is_a?(Proc) and options and options.has_key?(:field)} : {}
+      scope.tableficate_add_data(:field_map, Hash[filters_with_field.map{|name, options| [name, options[:field]]}])
       scope
     end
 
@@ -75,5 +109,13 @@ module Tableficate
       end
     end
     private :get_full_column_name
+
+    def prepare_value(value)
+      value.strip! if value.respond_to?(:strip!)
+      value = true if value == 'true'
+      value = false if value == 'false'
+      value
+    end
+    private :prepare_value
   end
 end