widget_list 1.0.4 → 1.0.5

data/README.md

@@ -20,6 +20,7 @@ In rails you have will_paginate and other ones like it using the ActiveRecord ap
 * Session rememberance for each list/view of what was last sorted, which page the person was on, the limit and search filters
 * Ability to set a cool custom HTML arrow which draws a hidden DIV intended for someone to put custom widgets inside of to pass new filters to the list before it executes
 * Buttons for each row and areas on the bottom of the grid where you can add "Action buttons"
+* Export visible data as CSV
 
 ## Screenshots
 
@@ -51,6 +52,8 @@ Or install it yourself as:
 
 You can either follow the below instructions or take a look at the changes here https://github.com/davidrenne/widget_list_example/commit/e4e8ab54edcf8bc4538b1850ee762c13bc6f5316
 
+I recommend if you use widget_list in production that you use config.consider_all_requests_local = true as errors will be handled but the base lists will still draw.
+
 ### #1 - Add widget_list CSS and JS to your application css and js
 
     Change application.css to:
@@ -87,28 +90,73 @@ You can either follow the below instructions or take a look at the changes here
 ### Example Calling Page That Sets up Config and calls WidgetList.render
 
    
-    WidgetList::List.get_database.create_table :items do
-      primary_key :id
-      String :name
-      Float :price
-      Int :sku
-      Date :date_added
+    #
+    # Load Sample "items" Data. Comment out in your first time executing a widgetlist to create the items table
+    #
+    begin 
+        WidgetList::List.get_database.create_table :items do
+          primary_key :id
+          String :name
+          Float :price
+          Int :sku
+          Date :date_added
+        end
+        items = WidgetList::List.get_database[:items]
+        100.times {
+          items.insert(:name => 'abc', :price => rand * 100, :date_added => '2008-02-01', :sku => 12345)
+          items.insert(:name => '123', :price => rand * 100, :date_added => '2008-02-02', :sku => 54321)
+          items.insert(:name => 'asdf', :price => rand * 100, :date_added => '2008-02-03', :sku => 67895)
+          items.insert(:name => 'qwerty', :price => rand * 100, :date_added => '2008-02-04', :sku => 66666)
+          items.insert(:name => 'poop', :price => rand * 100, :date_added => '2008-02-05', :sku => 77777)
+        }
+    rescue Exception => e
+      #
+      # Table already exists
+      #
+      logger.info "Test table in items already exists? " + e.to_s
     end
-    items = WidgetList::List.get_database[:items]
-    100.times {
-      items.insert(:name => 'abc', :price => rand * 100, :date_added => '2008-02-01', :sku => 12345)
-      items.insert(:name => '123', :price => rand * 100, :date_added => '2008-02-02', :sku => 54321)
-      items.insert(:name => 'asdf', :price => rand * 100, :date_added => '2008-02-03', :sku => 67895)
-      items.insert(:name => 'qwerty', :price => rand * 100, :date_added => '2008-02-04', :sku => 66666)
-      items.insert(:name => 'poop', :price => rand * 100, :date_added => '2008-02-05', :sku => 77777)
-    }  
     
+    list_parms   = {}
+
+    #
+    # Give it a name, some SQL to feed widget_list and set a noDataMessage
+    #
+    list_parms['name']          = 'ruby_items_yum'
+
+    #
+    # Handle Dynamic Filters
+    #
+    if $_REQUEST.key?('switch_grouping') && $_REQUEST['switch_grouping'] == 'Item Name'
+      groupByFilter       = 'item'
+      countSQL            = 'COUNT(1) as cnt,'
+      groupBySQL          = 'GROUP BY name'
+    elsif  $_REQUEST.key?('switch_grouping') && $_REQUEST['switch_grouping'] == 'Sku Number'
+      groupByFilter       = 'sku'
+      countSQL            = 'COUNT(1) as cnt,'
+      groupBySQL          = 'GROUP BY sku'
+    else
+      groupByFilter       = 'none'
+      countSQL            = ''
+      groupBySQL          = ''
+    end
+
+    list_parms['filter']    = []
+    drillDown, filterValue  = WidgetList::List::get_filter_and_drilldown(list_parms['name'])
+
+    case drillDown
+      when 'filter_by_name'
+        list_parms['filter'] << " name = '" + filterValue + "'"
+      when 'filter_by_sku'
+        list_parms['filter'] << " sku =  '" + filterValue + "'"
+    end
+
+
+
     #
     # Setup your first widget_list
     #
 
     button_column_name = 'actions'
-    list_parms   = {}
 
     #
     # action_buttons will add buttons to the bottom of the list.
@@ -117,11 +165,24 @@ You can either follow the below instructions or take a look at the changes here
     action_buttons =  WidgetList::Widgets::widget_button('Add New Item', {'page' => '/add/'} ) + WidgetList::Widgets::widget_button('Do something else', {'page' => '/else/'} )
 
     #
-    # Give it a name, some SQL to feed widget_list and set a noDataMessage
+    # Give some SQL to feed widget_list and set a noDataMessage
     #
-    list_parms['name']          = 'ruby_items_yum'
     list_parms['searchIdCol']   = ['id','sku']
-    list_parms['view']          = '(SELECT \'\'  as checkbox,a.* FROM items a ) a'
+    list_parms['view']          = '(
+                                     SELECT
+                                           ' + countSQL + '
+                                           ' + WidgetList::List::build_drill_down_link(list_parms['name'],'filter_by_name','a.name','a.name','name_linked') + '
+                                           ' + WidgetList::List::build_drill_down_link(list_parms['name'],'filter_by_sku','a.sku','a.sku','sku_linked') + '
+                                           \'\'    AS checkbox,
+                                           a.id    AS id,
+                                           a.name  AS name,
+                                           a.sku   AS sku,
+                                           a.price AS price,
+                                           a.date_added AS date_added
+                                       FROM
+                                           items a
+                                     ' + groupBySQL + '
+                                   ) a'
     list_parms['noDataMessage'] = 'No Ruby Items Found'
     list_parms['title']         = 'Ruby Items!!!'
 
@@ -133,7 +194,7 @@ You can either follow the below instructions or take a look at the changes here
     mini_buttons['button_edit'] = {'page'       => '/edit',
                                    'text'       => 'Edit',
                                    'function'   => 'Redirect',
-                                     #pass tags to pull from each column when building the URL
+                                   #pass tags to pull from each column when building the URL
                                    'tags'       => {'my_key_name' => 'name','value_from_database'=>'price'}}
 
     mini_buttons['button_delete'] = {'page'       => '/delete',
@@ -142,10 +203,10 @@ You can either follow the below instructions or take a look at the changes here
                                      'innerClass' => 'danger'}
     list_parms['buttons']                                            = {button_column_name => mini_buttons}
     list_parms['fieldFunction']                                      = {
-                                                                          button_column_name => "''",
-                                                                          'date_added'  => ['postgres','oracle'].include?(WidgetList::List.get_database.db_type) ? "TO_CHAR(date_added, 'MM/DD/YYYY')" : "date_added"
-                                                                       }
-    list_parms['groupByItems']    = ['All Records','Item Name']
+      button_column_name => "''",
+      'date_added'  => ['postgres','oracle'].include?(WidgetList::List.get_database.db_type) ? "TO_CHAR(date_added, 'MM/DD/YYYY')" : "date_added"
+    }
+    list_parms['groupByItems']    = ['All Records','Item Name', 'Sku Number']
 
     #
     # Generate a template for the DOWN ARROW for CUSTOM FILTER
@@ -166,10 +227,10 @@ You can either follow the below instructions or take a look at the changes here
     button_search['onclick']      = "alert('This would search, but is not coded.  That is for you to do')"
 
     list_parms['list_search_form'] = WidgetList::Utils::fill( {
-                              '<!--COMMENTS-->'            => WidgetList::Widgets::widget_input(input),
-                              '<!--BUTTON_SEARCH-->'       => WidgetList::Widgets::widget_button('Search', button_search),
-                              '<!--BUTTON_CLOSE-->'        => "HideAdvancedSearch(this)" } ,
-    '
+                                                                '<!--COMMENTS-->'            => WidgetList::Widgets::widget_input(input),
+                                                                '<!--BUTTON_SEARCH-->'       => WidgetList::Widgets::widget_button('Search', button_search),
+                                                                '<!--BUTTON_CLOSE-->'        => "HideAdvancedSearch(this)" } ,
+                                                              '
     <div id="advanced-search-container">
     <div class="widget-search-drilldown-close" onclick="<!--BUTTON_CLOSE-->">X</div>
       <ul class="advanced-search-container-inline" id="search_columns">
@@ -187,89 +248,94 @@ You can either follow the below instructions or take a look at the changes here
     #
 
     list_parms.deep_merge!({'fields' =>
-                    {
-                      'checkbox'=> 'checkbox_header',
-                    }
-                 })
-                 
+                              {
+                                'checkbox'=> 'checkbox_header',
+                              }
+                           })
+
     list_parms.deep_merge!({'fields' =>
-                    {
-                      'id'=> 'Item Id',
-                    }
-                 })
-                 
+                              {
+                                'cnt'=> 'Total Items In Group',
+                              }
+                           }) if groupByFilter != 'none'
+
+    list_parms.deep_merge!({'fields' =>
+                              {
+                                'id'=> 'Item Id',
+                              }
+                           }) if groupByFilter == 'none'
+
     list_parms.deep_merge!({'fields' =>
-                    {
-                      'name'=> 'Name',
-                    }
-                 })
-                 
+                              {
+                                'name_linked'=> 'Name',
+                              }
+                           }) if groupByFilter == 'none' or groupByFilter == 'item'
+
     list_parms.deep_merge!({'fields' =>
-                    {
-                      'price'=> 'Price of Item',
-                    }
-                 })
-                 
-                 
+                              {
+                                'price'=> 'Price of Item',
+                              }
+                           }) if groupByFilter == 'none'
+
     list_parms.deep_merge!({'fields' =>
-                    {
-                      'sku'=> 'Sku #',
-                    }
-                 })
-                 
+                              {
+                                'sku_linked'=> 'Sku #',
+                              }
+                           }) if groupByFilter == 'none' or groupByFilter == 'sku'
+
     list_parms.deep_merge!({'fields' =>
-                    {
-                      'date_added'=> 'Date Added',
-                    }
-                 })
- 
+                              {
+                                'date_added'=> 'Date Added',
+                              }
+                           }) if groupByFilter == 'none'
+
     list_parms.deep_merge!({'fields' =>
-                    {
-                      button_column_name => button_column_name.capitalize,
-                    }
-                 })
-                 
+                              {
+                                button_column_name => button_column_name.capitalize,
+                              }
+                           })
+
     #
     # Setup a custom field for checkboxes stored into the session and reloaded when refresh occurs
     #
 
     list_parms.deep_merge!({'inputs' =>
-                          {'checkbox'=>
-                             {'type' => 'checkbox'
-                             }
-                          }
-                       })
+                              {'checkbox'=>
+                                 {'type' => 'checkbox'
+                                 }
+                              }
+                           })
 
     list_parms.deep_merge!({'inputs' =>
-                          {'checkbox'=>
-                             {'items' =>
-                               {
-                                 'name'          => 'visible_checks[]',
-                                 'value'         => 'id', #the value should be a column name mapping
-                                 'class_handle'  => 'info_tables',
-                               }
-                             }
-                          }
-                       })
+                              {'checkbox'=>
+                                 {'items' =>
+                                    {
+                                      'name'          => 'visible_checks[]',
+                                      'value'         => 'id', #the value should be a column name mapping
+                                      'class_handle'  => 'info_tables',
+                                    }
+                                 }
+                              }
+                           })
 
     list_parms.deep_merge!({'inputs' =>
-                          {'checkbox_header'=>
-                             {'type' => 'checkbox'
-                             }
-                          }
-                       })
+                              {'checkbox_header'=>
+                                 {'type' => 'checkbox'
+                                 }
+                              }
+                           })
 
     list_parms.deep_merge!({'inputs' =>
-                          {'checkbox_header'=>
-                             {'items' =>
-                               {
-                                 'check_all'     => true,
-                                 'id'            => 'info_tables_check_all',
-                                 'class_handle'  => 'info_tables',
-                               }
-                             }
-                          }
-                       })
+                              {'checkbox_header'=>
+                                 {'items' =>
+                                    {
+                                      'check_all'     => true,
+                                      'id'            => 'info_tables_check_all',
+                                      'class_handle'  => 'info_tables',
+                                    }
+                                 }
+                              }
+                           })
 
     list = WidgetList::List.new(list_parms)
 
@@ -277,6 +343,11 @@ You can either follow the below instructions or take a look at the changes here
     # If AJAX, send back JSON
     #
     if $_REQUEST.key?('BUTTON_VALUE') && $_REQUEST['LIST_NAME'] == list_parms['name']
+      if $_REQUEST.key?('export_widget_list')
+        send_data(list.render(), :filename => list_parms['name'] + '.csv')
+        return
+      end
+      
       ret = {}
       ret['list']     = WidgetList::Utils::fill({ '<!--CUSTOM_CONTENT-->' =>  action_buttons } , list.render() )
       ret['list_id']  = list_parms['name']

data/lib/widget_list.rb

@@ -6,6 +6,7 @@ require 'widget_list/utils'
 require 'widget_list/tpl'
 require 'widget_list/widgets'
 require 'widget_list/railtie'
+require 'csv'
 require 'json'
 require 'uri'
 require 'extensions/action_controller_base'
@@ -142,6 +143,10 @@ module WidgetList
         'searchFieldsIn'      => {},            #White list of fields to include in a alpha-numeric based search
         'searchFieldsOut'     => {'id'=>true},  #Black list of fields to include in a alpha-numeric based search (default `id` to NEVER search when alpha seach)
 
+        #
+        #  Export
+        #
+        'showExport'          => true,
 
         #
         # Group By Box
@@ -210,6 +215,8 @@ module WidgetList
         'row_hooks'           => {}
       }
 
+      @csv          = []
+      @csv          << []
       @totalRowCount= 0
       @totalPages   = 0
       @fixHtmlLinksReplace = {}
@@ -536,7 +543,6 @@ module WidgetList
               fieldsToSearch.each { |fieldName,fieldTitle|
 
                 # new lodgette. if fieldFunction exists, find all matches and skip them
-                skip = false
 
                 if @items['fieldFunction'].key?(fieldName)
                   theField = @items['fieldFunction'][fieldName]  + cast_col()
@@ -544,15 +550,8 @@ module WidgetList
                   theField = tick_field() + "#{fieldName}" + cast_col() + tick_field()
                 end
 
-                (@items['inputs']||{}).each { |k,v|
-                  if fieldName == k
-                    skip = true
-                  end
-                }
-
-                if @items['buttons'].key?(fieldName)
-                  skip = true
-                end
+                skip = false
+                skip = skip_column(fieldName)
 
                 #buttons must ALWAYS BE ON THE RIGHT SIDE IN ORDER FOR THIS NOT TO SEARCH A NON-EXISTENT COLUMN  (used to be hard coded to 'features' as a column to remove)
                 if skip
@@ -661,6 +660,20 @@ module WidgetList
       end
     end
 
+    def skip_column(fieldName)
+      skip = false
+      (@items['inputs']||{}).each { |k,v|
+        if fieldName == k
+          skip = true
+        end
+      }
+
+      if @items['buttons'].key?(fieldName)
+        skip = true
+      end
+      return skip
+    end
+
     def tick_field()
       case WidgetList::List.get_database.db_type
         when 'postgres'
@@ -1019,9 +1032,15 @@ module WidgetList
                 @templateFill['<!--FILTER_HEADER-->'] = ''
               end
               @templateFill['<!--FILTER_HEADER-->']  += '<div class="fake-select"><div class="label">' + @items['groupByLabel'] + ':</div> ' + WidgetList::Widgets::widget_input(list_group) + '</div>'
+
+              if @items['showExport']
+                @templateFill['<!--FILTER_HEADER-->']  +=  WidgetList::Widgets::widget_button('Export CSV', {'onclick' => 'ListExport(\'' + @items['name'] + '\');'}, true)
+              end
+
             end
           end
         end
+
       rescue Exception => e
         out = '<tr><td colspan="50"><div id="noListResults">' + generate_error_output(e) + @items['noDataMessage'] + '</div></td></tr>'
         if !@templateFill.key?('<!--DATA-->')
@@ -1031,8 +1050,15 @@ module WidgetList
         end
       end
 
-      return WidgetList::Utils::fill(@templateFill, @items['template'])
-
+      if $_REQUEST.key?('export_widget_list')
+        csv = ''
+        @csv.each{ |v|
+          csv += v.to_csv
+        }
+        return csv
+      else
+        return WidgetList::Utils::fill(@templateFill, @items['template'])
+      end
     end
 
     def build_pagination()
@@ -1292,6 +1318,12 @@ module WidgetList
           #
           fieldTitle = build_column_input(fieldTitle)
 
+        else
+
+          if $_REQUEST.key?('export_widget_list') && !skip_column(field)
+            @csv[0] << fieldTitle
+          end
+
         end
 
         if (@items['useSort'] && (@items['columnSort'].include?(field) || (@items['columnSort'].key?(field)) && !@items['columnNoSort'].include?(field)) || (@items['columnSort'].empty? && !@items['columnNoSort'].include?(field)))
@@ -1384,6 +1416,7 @@ module WidgetList
 
           headers << WidgetList::Utils::fill(pieces, @items[templateIdx])
         end
+
       }
 
       @templateFill['<!--COLSPAN_FULL-->'] = headers.count()
@@ -1714,7 +1747,8 @@ module WidgetList
           rows = []
           j    = 0
           for j in j..max
-            columns = []
+            columns        = []
+            row_values     = []
             customRowColor = ''
             customRowStyle = ''
 
@@ -1742,11 +1776,12 @@ module WidgetList
               #
               if @items['links'].key?(column) && @items['links'][column].class.name == 'Hash'
                 onClick = build_column_link(column,j)
+              end
 
-                #
-                # Column is a Button
-                #
-              elsif @items['buttons'].key?(column) && @items['buttons'][column].class.name == 'Hash'
+              #
+              # Column is a Button
+              #
+              if @items['buttons'].key?(column) && @items['buttons'][column].class.name == 'Hash'
                 content = build_column_button(column, j)
 
 
@@ -1764,13 +1799,13 @@ module WidgetList
               else
                 cleanData = strip_tags(@results[column.upcase][j].to_s)
 
+                row_values << cleanData
+
                 #
                 # For now disable length parser
                 #
                 if false && cleanData.length > @items['strlength']
-
                   content = @results[column.upcase][j].to_s[ 0, @items['strlength'] ] + '...'
-
                 else
                   content = @results[column.upcase][j].to_s
                 end
@@ -1781,6 +1816,7 @@ module WidgetList
                 if !@items['allowHTML']
                   content = strip_tags(content)
                 end
+
                 content = WidgetList::List.get_database._bind(content, @items['bindVarsLegacy'])
 
                 # Column color
@@ -1854,13 +1890,18 @@ module WidgetList
               colPieces['<!--ONCLICK-->'] = onClick
               colPieces['<!--TITLE-->']   = contentTitle #todo htmlentities needed ?
               colPieces['<!--CONTENT-->'] = content
+
               #
               # Assemble the Column
               #
               columns << WidgetList::Utils::fill(colPieces, @items['col'])
-
             }
 
+
+            if $_REQUEST.key?('export_widget_list')
+              @csv << row_values
+            end
+
             #Draw the row
             #
 
@@ -1895,11 +1936,18 @@ module WidgetList
           @templateFill['<!--DATA-->'] = rows.join('')
 
         else
-          @templateFill['<!--DATA-->'] = '<tr><td colspan="50"><div id="noListResults">' + generate_error_output() + @items['noDataMessage'] + '</div></td></tr>'
+
+          err_message = (WidgetList::List.get_database.errors) ? @items['noDataMessage'] + ' <span style="color:red">(An error occurred)</span>' : @items['noDataMessage']
+
+          @templateFill['<!--DATA-->'] = '<tr><td colspan="50"><div id="noListResults">' + generate_error_output() + err_message + '</div></td></tr>'
+
         end
 
       else
-        @templateFill['<!--DATA-->'] = '<tr><td colspan="50"><div id="noListResults">' + generate_error_output() + @items['noDataMessage'] + '</div></td></tr>'
+
+        err_message = (WidgetList::List.get_database.errors) ? @items['noDataMessage'] + ' <span style="color:red">(An error occurred)</span>' : @items['noDataMessage']
+
+        @templateFill['<!--DATA-->'] = '<tr><td colspan="50"><div id="noListResults">' + generate_error_output() + err_message + '</div></td></tr>'
       end
 
     end
@@ -2078,4 +2126,4 @@ module WidgetList
 
   end
 
-endx
+end