widget_list 1.1.7 → 1.1.8

data/README.md

@@ -1,8 +1,12 @@
 # WidgetList
 ====================
 
+****
+
 ## Introduction
 
+****
+
 This is my first gem ever!
 
 I feel like there are not very good lists in ruby/rails and/or dont care to find any because nothing will compare to widget_list's implementation.
@@ -11,31 +15,50 @@ In rails you have will_paginate and other ones like it using the ActiveRecord ap
 
 * A sleek ajaxified list
 * Supports *ALL Databases (Haven't tested everything yet though, I am sure there are tweaks for each DB). mysql, postgres, oracle and sqllite tested (basic example)
-* Full sorting ASC/DESC of list via ajax
+* Full sorting ASC/DESC and paging/limits of list via ajax
 * Easily add row level buttons for each row
 * Custom tags to pass to be replaced by actual data from each column/value
-* Search bar/Ajax searching
+* Automatic wildcard search support as well as CSV numeric parsing of when to perform a LIKE search or an IN statement on the primary keys
 * Column mappings and names
+* Drill down link helper functions to allow user to click and filter the list by the particular record value
 * Checkboxes for each row for custom selection and mass actions
 * 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
+* Ability to set a 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
+* Grouping/Predefined report filter feature
+
+****
 
 ## Screenshots
 
+****
+
 Main Example Loaded:
 ![](http://davidrenne.com/github/widget_list/main.png)
 
 Filter Drop Downs:
 ![](http://davidrenne.com/github/widget_list/filtered.png)
 
-Searching a row:
+Searching a row (with wild card search):
 ![](http://davidrenne.com/github/widget_list/search.png)
 
+Searching "name=asdf_18" (With ActiveRecord and Ransack hook):
+![](http://davidrenne.com/github/widget_list/ransack1.png)
+
+Searching "name=asdf_18" and "sku<9000"(With ActiveRecord and Ransack hook):
+![](http://davidrenne.com/github/widget_list/ransack2.png)
+
+Searching "name=asdf_18" and "sku < 9000" and "price > 67" (With ActiveRecord and Ransack hook):
+![](http://davidrenne.com/github/widget_list/ransack3.png)
+
+
+****
 
 ## Installation
 
+****
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -49,15 +72,24 @@ Or install it yourself as:
 ```ruby
     $ gem install widget_list
 ```
+
+****
+
 ## Usage/Examples
 
+****
+
 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.
 
 
+****
+
 ## Feature Configurations
 
+****
+
 widget_list features and configurations primarily work by a single large hash passed to the constructor with the features you need for the given request which changes how the list is displayed or filtered.
 
 `name` - The unique name/id's of all the pieces that make up your widget list `default=([*('A'..'Z'),*('0'..'9')]-%w(0 1 I O)).sample(16).join`
@@ -154,6 +186,8 @@ widget_list features and configurations primarily work by a single large hash pa
 
 `listSearchForm` -  Allows you to pass a custom form for the ARROW drop down for advanced searching `default=''`
 
+`ransackSearch` -  If you pass ModelName.search(params[:q]) ransack will show up in your advanced search `default=false`
+
 `columnStyle` -  Column styles.  KEY=column name VALUE= the inline style applied `default={}`
 
 `columnClass` -  Column class.  KEY=column name VALUE= the class name `default={}`
@@ -246,8 +280,11 @@ Style a row based on the value of the column.
   
   Go To http://localhost:3000/widget_list_examples/ruby_items
 
+****
+
 ### Example Calling Page That Sets up Config and calls WidgetList.render
 
+****
    
 ```ruby
     #
@@ -547,8 +584,12 @@ Style a row based on the value of the column.
     end
 ```
 
+****
+
 ## Contributing
 
+****
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/app/views/widget_list/_condition_fields.html.erb

@@ -0,0 +1,10 @@
+<div class="field">
+  <% local_assigns['ransack'].attribute_fields do |a| %>
+    <%= a.attribute_select %>
+  <% end %>
+  <%= local_assigns['ransack'].predicate_select %>
+  <% local_assigns['ransack'].value_fields do |v| %>
+    <%= v.text_field :value, :size => 10 %>
+  <% end %>
+  <%= link_to "remove", '#', class: "remove_fields" %>
+</div>

data/app/views/widget_list/_ransack_fields.html.erb

@@ -0,0 +1,14 @@
+<%= search_form_for local_assigns['search_object'], url: local_assigns['url'], method: :post, :authenticity_token => false do |f| %>
+
+  <%= f.condition_fields do |c| %>
+    <%= raw ActionController::Base.new.render_to_string(:partial => 'widget_list/condition_fields', :locals => {  'ransack' => c }) %>
+  <% end %>
+
+<%
+   new_object = f.object.send "build_condition"
+   fields = f.send("condition_fields", new_object, child_index: "new_condition") do |c|
+     raw ActionController::Base.new.render_to_string(:partial => 'widget_list/condition_fields', :locals => {  'ransack' => c })
+   end
+%>
+  <%= link_to("Add Conditions", '#', class: "add_fields", data: {id: "new_condition", fields: fields.gsub("\n", "")}) %>
+<% end %>

data/lib/widget_list.rb

@@ -1,3 +1,4 @@
+require 'ransack'
 require 'widget_list/version'
 require 'widget_list/hash'
 require 'widget_list/string'
@@ -192,6 +193,11 @@ module WidgetList
 
       @items = WidgetList::Widgets::populate_items(list,@items)
 
+      # If ransack is used
+      if @items['view'].class.name == 'ActiveRecord::Relation' && @items['ransackSearch'].class.name == 'Ransack::Search'
+        @items['ransackSearch'].build_condition if @items['ransackSearch'].conditions.empty?
+      end
+
       # current_db is a flag of the last known primary or secondary YML used or defaulted when running a list
       @current_db_selection = @items['database']
 
@@ -586,7 +592,7 @@ module WidgetList
         #
         # carryOverRequests will allow you to post custom things from request to all sort/paging URLS for each ajax
         #
-        'carryOverRequsts'    => ['switch_grouping','group_row_id'],
+        'carryOverRequsts'    => ['switch_grouping','group_row_id','q'],
 
         #
         # Head/Foot
@@ -632,6 +638,7 @@ module WidgetList
         # Advanced searching
         #
         'listSearchForm'      => '',
+        'ransackSearch'       => false,
 
         #
         # Column Specific
@@ -814,7 +821,7 @@ module WidgetList
         if key.include?(name)
           $_SESSION['list_checks'].delete(key)
         end
-      } if $_SESSION.key?('list_checks')
+      } if $_SESSION.key?('list_checks')  && !$_SESSION['list_checks'].nil? && !$_SESSION['list_checks'].empty?
 
     end
 
@@ -1022,9 +1029,6 @@ module WidgetList
         @templateFill['<!--HEADER_TXT_COLOR-->']     = @items['headerFontColor']
         @templateFill['<!--FOOTER_TXT_COLOR-->']     = @items['footerFontColor']
         @templateFill['<!--TITLE-->']                = @items['title']
-        @templateFill['<!--NAME-->']                 = @items['name']
-        @templateFill['<!--JUMP_URL-->']             = WidgetList::Utils::build_url(@items['pageId'],listJumpUrl,(!$_REQUEST.key?('BUTTON_VALUE')))
-        @templateFill['<!--JUMP_URL_NAME-->']        = @items['name'] + '_jump_url'
         @templateFill['<!--CLASS-->']                = @items['class']
 
         if @totalRowCount > 0
@@ -1103,6 +1107,10 @@ module WidgetList
               @headerPieces['searchBar']            = WidgetList::Widgets::widget_input(list_search)
               @templateFill['<!--FILTER_HEADER-->'] = @headerPieces['searchBar']
 
+              if @items['ransackSearch'] != false
+                @templateFill['<!--RANSACK-->'] = ActionController::Base.new.render_to_string(:partial => 'widget_list/ransack_fields', :locals => { 'search_object' => @items['ransackSearch'], 'url' => '--JUMP_URL--'})
+              end
+
             end
 
             #
@@ -1171,6 +1179,11 @@ module WidgetList
           end
         end
 
+        @templateFill['<!--NAME-->']                 = @items['name']
+        @templateFill['<!--JUMP_URL-->']             = WidgetList::Utils::build_url(@items['pageId'],listJumpUrl,(!$_REQUEST.key?('BUTTON_VALUE')))
+        @templateFill['--JUMP_URL--']                = @templateFill['<!--JUMP_URL-->']
+        @templateFill['<!--JUMP_URL_NAME-->']        = @items['name'] + '_jump_url'
+
       rescue Exception => e
         out = '<tr><td colspan="50"><div id="noListResults">' + generate_error_output(e) + @items['noDataMessage'] + '</div></td></tr>'
         if !@templateFill.key?('<!--DATA-->')
@@ -1850,11 +1863,7 @@ module WidgetList
       end
 
       if WidgetList::List.get_db_type(items[:primary_database]) == 'oracle'
-        if $_REQUEST.key?('export_widget_list')
-          link = "#{items[:column_to_show]} #{WidgetList::List::is_sequel(items[:primary_database]) ? " as #{items[:column_alias]} " : ""}"
-        else
-          link = %[q'[<a style='cursor:pointer;color:#{items[:link_color]};' class='#{items[:column_alias]}_drill#{items[:column_class]}' onclick='#{items[:js_function_name]}("#{items[:drill_down_name]}", ListDrillDownGetRowValue(this) ,"#{items[:list_id]}"#{items[:extra_js_func_params]});#{items[:extra_function]}'>]' #{WidgetList::List::concat_string(items[:primary_database])}#{items[:column_to_show]}#{WidgetList::List::concat_string(items[:primary_database])}q'[</a><script class='val-db' type='text'>]' #{WidgetList::List::concat_string(items[:primary_database])} #{items[:data_to_pass_from_view]} #{WidgetList::List::concat_string(items[:primary_database])} q'[</script>]' #{WidgetList::List::concat_outer(items[:primary_database])} #{WidgetList::List::is_sequel(items[:primary_database]) ? " as #{items[:column_alias]} " : ""}]
-        end
+        link = %[q'[<a style='cursor:pointer;color:#{items[:link_color]};' class='#{items[:column_alias]}_drill#{items[:column_class]}' onclick='#{items[:js_function_name]}("#{items[:drill_down_name]}", ListDrillDownGetRowValue(this) ,"#{items[:list_id]}"#{items[:extra_js_func_params]});#{items[:extra_function]}'>]' #{WidgetList::List::concat_string(items[:primary_database])}#{items[:column_to_show]}#{WidgetList::List::concat_string(items[:primary_database])}q'[</a><script class='val-db' type='text'>]' #{WidgetList::List::concat_string(items[:primary_database])} #{items[:data_to_pass_from_view]} #{WidgetList::List::concat_string(items[:primary_database])} q'[</script>]' #{WidgetList::List::concat_outer(items[:primary_database])} #{WidgetList::List::is_sequel(items[:primary_database]) ? " as #{items[:column_alias]} " : ""}]
       else
         if WidgetList::List.get_db_type(items[:primary_database]) == 'postgres'
           link = %['<a style="cursor:pointer;color:#{items[:link_color]};" class="#{items[:column_alias]}_drill#{items[:column_class]}" onclick="#{items[:js_function_name]}(''#{items[:drill_down_name]}'', ListDrillDownGetRowValue(this) ,''#{items[:list_id]}''#{items[:extra_js_func_params]});#{items[:extra_function]}">"' #{WidgetList::List::concat_string(items[:primary_database])}#{items[:column_to_show]}#{WidgetList::List::concat_string(items[:primary_database])}'</a><script class="val-db" type="text">' #{WidgetList::List::concat_string(items[:primary_database])} #{items[:data_to_pass_from_view]} #{WidgetList::List::concat_string(items[:primary_database])}'</script>' #{WidgetList::List::is_sequel(items[:primary_database]) ? " as #{items[:column_alias]} " : ""}]
@@ -1862,15 +1871,15 @@ module WidgetList
           link = %[#{WidgetList::List::concat_inner(items[:primary_database])}"<a style='cursor:pointer;color:#{items[:link_color]};' class='#{items[:column_alias]}_drill#{items[:column_class]}' onclick='#{items[:js_function_name]}(#{WidgetList::List::double_quote(items[:primary_database])}#{items[:drill_down_name]}#{WidgetList::List::double_quote(items[:primary_database])}, ListDrillDownGetRowValue(this) ,#{WidgetList::List::double_quote(items[:primary_database])}#{items[:list_id]}#{WidgetList::List::double_quote(items[:primary_database])}#{items[:extra_js_func_params]});#{items[:extra_function]}'>"#{WidgetList::List::concat_string(items[:primary_database])}#{items[:column_to_show]}#{WidgetList::List::concat_string(items[:primary_database])}"</a><script class='val-db' type='text'>"#{WidgetList::List::concat_string(items[:primary_database])} #{items[:data_to_pass_from_view]} #{WidgetList::List::concat_string(items[:primary_database])}"</script>"#{WidgetList::List::concat_outer(items[:primary_database])} #{WidgetList::List::is_sequel(items[:primary_database]) ? " as #{items[:column_alias]} " : ""}]
         end
       end
-      
+
       if $_REQUEST.key?('export_widget_list')
         link = "#{items[:column_to_show]} #{WidgetList::List::is_sequel(items[:primary_database]) ? " as #{items[:column_alias]} " : ""}"
       end
-      
+
       return link
 
-    end 
- 
+    end
+
     def self.concat_string(primary)
 
       case WidgetList::List.get_db_type(primary)

data/lib/widget_list/hash.rb

@@ -1,5 +1,41 @@
 class Hash
 
+  def to_params
+    params = ''
+    stack = []
+
+    each do |k, v|
+      if v.is_a?(Hash)
+        stack << [k,v]
+      elsif v.is_a?(Array)
+        stack << [k,Hash.from_array(v)]
+      else
+        params << "#{k}=#{v}&"
+      end
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << ["#{parent}[#{k}]", v]
+        else
+          params << "#{parent}[#{k}]=#{v}&"
+        end
+      end
+    end
+
+    params.chop!
+    params
+  end
+
+  def self.from_array(array = [])
+    h = Hash.new
+    array.size.times do |t|
+      h[t] = array[t]
+    end
+    h
+  end
+
   # Merges self with another hash, recursively.
   #
   # This code was lovingly stolen from some random gem:

data/lib/widget_list/utils.rb

@@ -23,7 +23,11 @@ module WidgetList
     def self.build_query_string(args)
       q = []
       args.each { |k,v|
-        q << k.to_s + '=' + URI.encode(URI.decode(v.to_s))
+        if v.class.name == 'Hash'
+          q << {k => v}.to_params
+        else
+          q << k.to_s + '=' + URI.encode(URI.decode(v.to_s))
+        end
       }
       q.join('&')
     end

data/lib/widget_list/version.rb

@@ -1,3 +1,3 @@
 module WidgetList
-  VERSION = "1.1.7"
+  VERSION = "1.1.8"
 end

data/vendor/assets/javascripts/widget_list.js

@@ -771,3 +771,21 @@ jQuery(document).ready(function($) {
     });
 });
 
+(function() {
+
+    jQuery(function() {
+        $('form').on('click', '.remove_fields', function(event) {
+            $(this).closest('.field').remove();
+            return event.preventDefault();
+        });
+        return $('form').on('click', '.add_fields', function(event) {
+            var regexp, time;
+            time = new Date().getTime();
+            regexp = new RegExp($(this).data('id'), 'g');
+            $(this).before($(this).data('fields').replace(regexp, time));
+            return event.preventDefault();
+        });
+    });
+
+}).call(this);
+

data/vendor/assets/stylesheets/widget_list.css

@@ -766,7 +766,7 @@ ul#pagination li div.active
 /**
 * Search form
 */
-div#advanced-search-container ul.advanced-search-container-inline, div#advanced-search-container ul {list-style:none; margin:0px; padding:3px; height:51px; width:450px}
+div#advanced-search-container ul.advanced-search-container-inline, div#advanced-search-container ul {list-style:none; margin:0px; padding:3px; width:450px}
 div#advanced-search-container ul.advanced-search-container-inline input.info-input, div#advanced-search-container ul input.info-input {font-size:11px}
    div#advanced-search-container ul.advanced-search-container-inline li {display:inline-block;width:428px; margin-top:4px;}
    div#advanced-search-container ul.advanced-search-container-inline li#required_message_inline {font-size:10px}

data/widget_list.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |gem|
   # SEQUEL IS NOW OPTIONAL!! I am sure most people will be using ActiveRecord ORM
   # I am including it as a dependency just because it is easier to pull it down and have it available
   #
-  gem.add_dependency('sequel', '3.42.0')  
+  gem.add_dependency('sequel', '3.42.0')
+
+  gem.add_dependency('ransack', '0.7.2')
   
   gem.files         = `git ls-files`.split($/)
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: widget_list
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -27,6 +27,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.42.0
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 description: An Advanced and flexible ajax data grid. Supports several databases where
   data is pulled from either using Sequel ORM (optional even though is a dependency),
   Active Record Models or Raw SQL.
@@ -50,6 +66,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/widget_list/_condition_fields.html.erb
+- app/views/widget_list/_ransack_fields.html.erb
 - lib/extensions/action_controller_base.rb
 - lib/widget_list.rb
 - lib/widget_list/engine.rb