table_on_steroids 0.1.0.5 → 0.1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461a53274c2bf291e7b89db8d818875153976f2d65473d3f041f2ed4810c5c89
-  data.tar.gz: 1558e8e8b3287e65ccc86b939e967a0ebe2497a50cb8f1f592dec444a418a868
+  metadata.gz: 2d4edd10e8041898d2a51d6ce362e6317579c0e16f8862bff1fcbc82f1111ff2
+  data.tar.gz: c51917c51b558e9a4a158b8e5d3ed688064e945a44c689be91a3c759e23ee719
 SHA512:
-  metadata.gz: d94a64d6d4236385d4278c799dbf1e2d675257c726b88b19e99cc02be2d3641a2d6d5126f8240753a19ae9e2cdfb17f45573443791e5e388975ad04e7cf8c806
-  data.tar.gz: 41874617183a0abd085e9f799701be203dab310b8fe98413a266cde3afdd49d3356443b4caa439425fac53d3c54923c71618ded10452aa9503ad3418ab48d3cc
+  metadata.gz: 7f83e38d52722c6bcac3b3a9078a3a6bcc38f88200b50632348d207af53c6f15f48cd4e80abe2cab53cc0fd5eef17dcc7dfbca094bd88c465f85c0512006f845
+  data.tar.gz: 2666272c49fc25c18b35a175d61c83553d96f818229dfbfde48fac496b47b71c35bdce376a0a5d5c33cd654ded83b5d29fc9ff36d8744c89c63db82a503c61f9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_on_steroids (0.1.0.5)
+    table_on_steroids (0.1.1.0)
       bootstrap-datepicker-rails (~> 1)
       bootstrap-multiselect-rails (~> 0.9)
       kaminari (~> 1.1)

data/README.md

@@ -22,7 +22,94 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Add assets
+
+application.js
+
+```
+//= require table_on_steroids
+```
+
+application.scss
+```
+    @import "table_on_steroids";
+```
+
+### In the controller
+#### Add the concern 
+
+```
+  require 'table_on_steroids'
+  include TableOnSteroids::TableConcern
+```
+
+#### Define a global search (optional)*
+```
+  def global_search
+    @global_search_lambda ||= nil #put whatever lambda you want here -> (objects, query) { objects.deep_search(query) }
+  end
+```
+
+#### Define your columns
+
+The columns are defined by a hash: 
+Key: a key defining the column
+
+options:
+ - *label*: column title
+ - *type*:
+ - *value_lambda*: how to get the value of this object. "context" is the view context. You can use it to call view methods (eg: `context.link_to` ... ; `context.render` ...)
+ - array : array lambdas for search and order
+        - filter_lambda
+        - order_lambda
+        - search_lambda
+ - activerecord : activerecord lambdas for search and order
+        - filter_lambda
+        - order_lambda
+        - search_lambda
+
+
+```
+def columns_on_steroid
+    @columns_on_steroid ||= {
+      'email' => {
+        label: "email",
+        type: 'order',
+        array: {
+          order_lambda: -> (objects) { objects.sort_by{ |o| o.user.email.downcase } }
+        },
+        activerecord: {
+          search_lambda: -> (objects, v) { objects.joins(:user).where('users.email ilike ?', ("%" + v + "%")) }
+        },
+        value_lambda: -> (object, context) { object.user.email } 
+      }, ..
+```
+#### Use the columns to search and order
+```
+    @objects = filter_and_order(@objects, columns_on_steroid, global_search)
+```
+#### Use the columns to create a csv
+add *download_value_lambda* to your table columns
+```
+    table_csv(@objects , columns_on_steroid_fulfillment)
+```
+
+### In the view
+
+Render the table
+
+```
+    = render partial: 'table_on_steroids/table_on_steroids', locals: { objects: @objects, columns: @columns_on_steroid}
+
+```
+
+_locals extra options:_
+- title
+- download_csv: the link of the download csv 
+- table_on_steroid_id
+- omit_columns
+
+
 
 ## Development
 

data/app/controllers/concerns/table_on_steroids/table_concern.rb

@@ -27,6 +27,7 @@
 #
 #####
 require 'kaminari'
+require 'csv'
 
 module TableOnSteroids
   module TableConcern
@@ -35,8 +36,8 @@ module TableOnSteroids
     included do
       OBJECTS_PER_PAGE = 50
     end
-
-    def filter_and_order(objects, columns_on_steroid, global_search=nil, include_counts=false )
+  
+    def filter_and_order(objects, columns_on_steroid, global_search=nil, include_counts=false, all_pages=false )
       # execute the global search if you have one
       objects = global_search.call(objects,params[:search]) if global_search && params[:search].present?
 
@@ -69,7 +70,7 @@ module TableOnSteroids
       end
 
       #pagination 
-      
+      return (include_counts ? [objects, 1, objects.count] : objects) if all_pages
       if(objects.is_a?(ActiveRecord::Base) || objects.is_a?(ActiveRecord::Relation))
         objects = objects.page(params[:page]).per(OBJECTS_PER_PAGE) 
         total_pages = objects.total_pages
@@ -82,8 +83,23 @@ module TableOnSteroids
       end
       include_counts ? [objects, total_pages, total_count] : objects
     end
-
-
+  
+    def table_csv(objects, columns_on_steroid)
+      titles = []
+      csvs = CSV.generate do |csv|
+        columns_on_steroid.select{ |c,v| v[:download_value_lambda].present? }.each{ |c,v| ((v[:download_label].present?) ? titles.push(*v[:download_label]) : titles << v[:label]) }
+        csv << titles
+        objects.each do |o|
+          vals = []
+          columns_on_steroid.select{ |c,v| v[:download_value_lambda].present? }.each do |c,v| 
+            vals.push(*v[:download_value_lambda].call(o))
+          end
+          csv << vals
+        end
+      end
+    end
+  
+  
     def objects_where(objects, columns_on_steroid, t)
       columns_on_steroid.select{ 
         |c,v| v[t] && v[t][:search_lambda].present? }.each{ 

data/app/views/table_on_steroids/_table_on_steroids.html.erb

@@ -10,6 +10,7 @@
 <% title ||= nil %>
 <% subtext ||= nil %>
 <% subtext_partial ||= nil %>
+<% csv_image ||= nil %>
 <% param_hash = CGI::parse(request.query_string) %>
 <% expected_column_keys = columns.map{|col,col_values| col }+columns.map{|col,col_values|("search_" + col)}+columns.map{|col,col_values|("search_operator_" + col)} %>
 <div class="table-on-steroids" id="<%= table_on_steroid_id %>">
@@ -54,8 +55,8 @@
   </div>
   <% if(download_csv) %>
     <div class="float-right">
-      <a href="<%= (download_csv + "?filter=#{request.query_string.to_s}") %>" style="float:right">
-        <%= image_tag "csv.png", :height => "25", :style => "padding-top:5px;" %>
+      <a href="<%= (download_csv + "?filter=#{request.query_string.to_s}") %>" style="float:right" target="_blank">
+        <%= image_tag csv_image || "csv.png", :height => "25", :style => "padding-top:5px;" %>
       </a>
     </div>
   <% end %>

data/app/views/table_on_steroids/_table_on_steroids_filters.html.erb

@@ -3,7 +3,7 @@
   <% columns_on_steroid.each_pair do | k , v | %>
     <td class="column column-<%= k %> <%= 'd-none' unless selected_columns.include?(k) %> filter-cell-left <%= v[:css_class].join(' ') if(v[:css_class]) %> <%= table_on_steroid_id %>">
       <% if v[:type] == 'filter' %>
-        <%= select_tag("filters[#{k}]", options_for_select(v[:select_values], params[:filters] && params[:filters][k]), multiple: v[:multiselect], class: 'selectpicker form-control filter-control', form: "knowledge_base_filters#{table_on_steroid_id}", data: { "none-selected-text" => v[:label], style: 'table-on-steroids-selectpicker ', table_on_steroid_id: table_on_steroid_id}, table_on_steroid_id: table_on_steroid_id ) %>
+        <%= select_tag("filters[#{k}]", options_for_select(v[:select_values], params[:filters] && params[:filters][k]), multiple: v[:multiselect], class: 'form-control filter-control', form: "knowledge_base_filters#{table_on_steroid_id}", data: { "none-selected-text" => v[:label], style: 'table-on-steroids-selectpicker ', table_on_steroid_id: table_on_steroid_id}, table_on_steroid_id: table_on_steroid_id ) %>
       <% elsif((v[:activerecord].present? && v[:activerecord][:search_lambda].present?) || (v[:array].present? && v[:array][:search_lambda].present?)) %>
         <% operator_present = (v[:datatype].present? && ['date','integer'].include?(v[:datatype])) %>
         <% if operator_present %>

data/lib/table_on_steroids/version.rb

@@ -1,3 +1,3 @@
 module TableOnSteroids
-  VERSION = "0.1.0.5"
+  VERSION = "0.1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_on_steroids
 version: !ruby/object:Gem::Version
-  version: 0.1.0.5
+  version: 0.1.1.0
 platform: ruby
 authors:
 - Marieke Gueye
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap-datepicker-rails
@@ -126,6 +126,7 @@ files:
 - lib/table_on_steroids.rb
 - lib/table_on_steroids/version.rb
 - table_on_steroids.gemspec
+- vendor/assets/images/csv.png
 - vendor/assets/javascripts/table_on_steroids.js
 - vendor/assets/stylesheets/table_on_steroids.scss
 homepage: http://www.github.com/mariekou