easy_data_tables 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cb80cf6b75f6538198a91b5e47dda21b23d33f16ad59017e23601c19c1f7f4b
-  data.tar.gz: f157300ea30e55dee0fbf082c8da2e9e3681a7e19b6ebf39d56e71b1e3279820
+  metadata.gz: f9f6075dc6b932de890fbe28050a1b6d3b417d5576e601ccb97b695cedffcc84
+  data.tar.gz: '09d60e1ba17eac10c7760bf908912d37b56cdda590543a9075938d55f8e1cc10'
 SHA512:
-  metadata.gz: f9db24e2600639ee0f711be2e123e410af17922cbb793380f930c2c137681fd85e1237cfe00e5a262242578b217897296aceeac4ff2a0b28c8dfb4eec2bfa394
-  data.tar.gz: 5b069d81d97bf2c07efbac3e05065dc5357d95111e74a5a56dc0dcfedd37f82d16746e64609fff0f8400f8318fc8470cc53058126ed1ccbe86a1461246e78ae8
+  metadata.gz: 67d03e29ff2f7725c8da4492f75ad4a6d3be78de093fe1e54fc1fc71775614e5075b2c731ffda8b835cfc515f6b0590a8e252952612fbd4cf97148bd3dce3d06
+  data.tar.gz: 3f59f1c2fd4302981e88af92ac01318b6634a046a93fc7703477ecafa58b82e3530fa8ac86328dcca937d3c20080786b58c58c5f53db470a0e1ebb18dd15dde1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_data_tables (0.1.1)
+    easy_data_tables (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,8 @@
 
 This gem provides a way to create fast tables based on the models of your db. It will expose a helper method `easy_data_table(columns, rows, grouping)`that will output a datatable with the rows and the columns you indicated.
 
+Two links above and below the table will allow you to export it on csv format
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,6 +26,11 @@ Or install it yourself as:
 
 You will have a method available once you install this gem: `easy_data_table(columns, rows, grouping)` in order to expose it, you need to add `helper EasyDataTables::Engine.helpers` to your app's ApplicationController. You can call this helper method in any view and it will output a table with the data you provide.
 
+In order to access the style of the application add: 
+`@import "easy_data_tables/application";`
+
+to your `application.scss`
+
 ### Parameters
 
 #### Columns
@@ -108,14 +115,18 @@ in order to have correct looking column labels you must have a I18n file that wi
 en:
   easy_data_tables: 
     data_table:
-        user_count: User count
-        user_count_title: "Count of all the users that have the row's status"
-        active_user_count: Active User Count
-        active_user_count_title: Active users for each status
-        active_user_expense: Active User Expense
-        active_user_expense_title: Sum of the expenses for the active users of each status
-        active_user_rate: Active User Rate
-        active_user_rate_title: % of active users over total users per status
+      user_count: User count
+      user_count_title: "Count of all the users that have the row's status"
+      active_user_count: Active User Count
+      active_user_count_title: Active users for each status
+      active_user_expense: Active User Expense
+      active_user_expense_title: Sum of the expenses for the active users of each status
+      active_user_rate: Active User Rate
+      active_user_rate_title: % of active users over total users per status
+    download_links:
+      download_formated_csv: Download Formated CSV
+      download_unformated_csv:  Download Unformated CSV
+    
 ```
 
 On hover on a column label, you will have the title that appears as a tooltip. 
@@ -141,3 +152,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pabloc
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+
+### v 0.2.0
+- added possibility of downloading the table as a csv (both formated and unformated)

data/Rakefile

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
 
-task default: :spec
+task default: :test

data/app/assets/stylesheets/easy_data_tables/application.css

@@ -0,0 +1,5 @@
+.easy-data-tables__links {
+  display: flex;
+  padding: 5px;
+  gap: 5px;
+}

data/app/helpers/easy_data_tables/table_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EasyDataTables
+  # Creates and exposes the helper method
+  module TableHelper
+    def easy_data_table(columns, label, grouping)
+      data_table = DataTable.new(
+        columns,
+        label,
+        grouping
+      )
+      render 'easy_data_tables/data_table', data_table: data_table
+    end
+  end
+end

data/app/models/easy_data_tables/column.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module EasyDataTables
+  # Column class, we can access the formated data and the data of a particular cell
+  class Column
+    attr_reader :label
+
+    # values = {}, label = '', type = 'Integer')
+    def initialize(args = {})
+      @label = args[:label] || ''
+      @type = args[:type] || 'Integer'
+      @default = args[:default] || 0
+      @collection = args[:collection]
+      @grouping = args[:grouping]
+      @agregate_function = args[:agregate_function]
+      @values = construct_values
+    end
+
+    def formated_data_at(row)
+      case @type
+      when 'Integer'
+        helpers.number_with_delimiter(data_at(row))
+      when 'Percentage'
+        helpers.number_to_percentage(data_at(row), precision: 2)
+      when 'Currency'
+        helpers.number_to_currency(data_at(row))
+      else
+        data_at(row)
+      end
+    end
+
+    def data_at(row)
+      @values[row]
+    end
+
+    private
+
+    def construct_values
+      Hash.new(@default)
+          .merge(@collection.send(*@grouping).send(*@agregate_function))
+          .merge({ 'TOTAL' => @collection.send(*@agregate_function) })
+    end
+
+    def helpers
+      ActionController::Base.helpers
+    end
+  end
+end

data/app/models/easy_data_tables/combined_column.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EasyDataTables
+  # combined columns. can substract and create rates
+  class CombinedColumn < EasyDataTables::Column
+    attr_accessor :columns
+
+    def initialize(args = {})
+      super(args)
+      @columns = args[:columns]
+      @method = args[:method]
+      @type = args[:type]
+      @label = args[:label]
+    end
+
+    def data_at(row)
+      combine(row)
+    end
+
+    private
+
+    def combine(row)
+      case @method
+      when 'rate'
+        columns[0].data_at(row).fdiv(columns[1].data_at(row)) * 100
+      when 'substract'
+        columns[0].data_at(row) - columns[1].data_at(row)
+      end
+    end
+
+    def construct_values; end
+
+    def helpers
+      ActionController::Base.helpers
+    end
+  end
+end

data/app/models/easy_data_tables/data_table.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module EasyDataTables
+  # creates the datatable and it's columns
+  class DataTable
+    attr_reader :columns, :rows, :labels
+
+    def initialize(columns, rows, grouping)
+      @grouping = grouping
+      @rows = rows + ['TOTAL']
+      @columns = treat_columns(columns)
+      @labels = @columns.map(&:label)
+    end
+
+    private
+
+    def treat_columns(columns)
+      convert_columns(columns)
+      columns.map! do |col|
+        if col.is_a?(CombinedColumn)
+          col.columns = columns.find_all { |col2| col.columns.include?(col2.label) }.sort do |column|
+            col.columns.index(column.label)
+          end
+        end
+        col
+      end
+    end
+
+    def convert_columns(columns)
+      columns.map! do |col|
+        if col[:column_type] == 'combined'
+          CombinedColumn.new(col)
+        else
+          Column.new(col.merge(grouping: @grouping))
+        end
+      end
+    end
+  end
+end

data/app/views/easy_data_tables/_data_table.html.erb

@@ -1,4 +1,5 @@
-<table class="table datatable" data-controller="datatable">
+<%= render 'easy_data_tables/download_links' %>
+<table class="table datatable" id="easy_data_table" data-controller="datatable">
   <thead>
     <tr>
       <th></th> 
@@ -16,11 +17,68 @@
           <%= row %>
         </td>
         <% data_table.columns.each do |column| %>
-          <td>
+          <td data-unformated-value="<%= column.data_at(row) %>">
             <%= column.formated_data_at(row) %>
           </td>
         <% end %>
       </tr>
     <% end %>
   </tbody>
-</table>
+</table>
+
+<%= render 'easy_data_tables/download_links' %>
+
+<script>
+  // Quick and simple export target #table_id into a csv
+  function download_unformated_table_as_csv(table_id, separator = ',') {
+      const rows = document.querySelectorAll('table#' + table_id + ' tr');
+      const csv = [];
+      for (let i = 0; i < rows.length; i++) {
+          let row = []
+          let cols = rows[i].querySelectorAll('td, th');
+          for (let j = 0; j < cols.length; j++) {
+              let data;
+              if (cols[j].dataset.unformatedValue) {
+                data = cols[j].dataset.unformatedValue
+              }
+              else {
+                data = cols[j].innerText.replace(/(\r\n|\n|\r)/gm, '').replace(/(\s\s)/gm, ' ')
+              }
+              data = data.replace(/"/g, '""');
+              row.push('"' + data + '"');
+          }
+          csv.push(row.join(separator));
+      }
+      createLink(csv, table_id)
+  }
+  
+  function download_formated_table_as_csv(table_id, separator = ',') {
+      const rows = document.querySelectorAll('table#' + table_id + ' tr');
+      const csv = [];
+      for (let i = 0; i < rows.length; i++) {
+          let row = []
+          let cols = rows[i].querySelectorAll('td, th');
+          for (let j = 0; j < cols.length; j++) {
+              let data = cols[j].innerText.replace(/(\r\n|\n|\r)/gm, '').replace(/(\s\s)/gm, ' ')
+              data = data.replace(/"/g, '""');
+              row.push('"' + data + '"');
+          }
+          csv.push(row.join(separator));
+      }
+      createLink(csv, table_id)
+  }
+
+  function createLink(csv, table_id) {
+      const csv_string = csv.join('\n');
+      // Download it
+      const filename = 'export_' + table_id + '_' + new Date().toLocaleDateString() + '.csv';
+      const link = document.createElement('a');
+      link.style.display = 'none';
+      link.setAttribute('target', '_blank');
+      link.setAttribute('href', 'data:text/csv;charset=utf-8,' + encodeURIComponent(csv_string));
+      link.setAttribute('download', filename);
+      document.body.appendChild(link);
+      link.click();
+      document.body.removeChild(link);
+  }
+</script>

data/app/views/easy_data_tables/_download_links.html.erb

@@ -0,0 +1,5 @@
+<div class="easy-data-tables__links">
+  <a href="#" onclick="download_unformated_table_as_csv('easy_data_table');"><%= t('.download_unformated_csv') %></a>
+  <span> | </span>
+  <a href="#" onclick="download_formated_table_as_csv('easy_data_table');"><%= t('.download_formated_csv') %></a>
+</div>

data/easy_data_tables.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/pablocm90/easy_data_tables'

data/lib/easy_data_tables.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 require 'easy_data_tables/version'
-# require "app/helpers/helper"
 require 'easy_data_tables/engine'
-# require "easy_data_tables/models/column"
-# require "easy_data_tables/models/combined_column"
 
 module EasyDataTables
   class Error < StandardError; end

data/lib/easy_data_tables/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyDataTables
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_data_tables
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Pablo Curell
@@ -26,11 +26,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/helpers/table_helper.rb
-- app/models/column.rb
-- app/models/combined_column.rb
-- app/models/data_table.rb
+- app/assets/stylesheets/easy_data_tables/application.css
+- app/helpers/easy_data_tables/table_helper.rb
+- app/models/easy_data_tables/column.rb
+- app/models/easy_data_tables/combined_column.rb
+- app/models/easy_data_tables/data_table.rb
 - app/views/easy_data_tables/_data_table.html.erb
+- app/views/easy_data_tables/_download_links.html.erb
 - bin/rails
 - easy_data_tables.gemspec
 - lib/easy_data_tables.rb

data/app/helpers/table_helper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Creates and exposes the helper method
-module TableHelper
-  def easy_data_table(columns, label, grouping)
-    data_table = DataTable.new(
-      columns,
-      label,
-      grouping
-    )
-    render 'easy_data_tables/data_table', data_table: data_table
-  end
-end

data/app/models/column.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-# Column class, we can access the formated data and the data of a particular cell
-class Column
-  attr_reader :label
-
-  # values = {}, label = '', type = 'Integer')
-  def initialize(args = {})
-    @label = args[:label] || ''
-    @type = args[:type] || 'Integer'
-    @default = args[:default] || 0
-    @collection = args[:collection]
-    @grouping = args[:grouping]
-    @agregate_function = args[:agregate_function]
-    @values = construct_values
-  end
-
-  def formated_data_at(row)
-    case @type
-    when 'Integer'
-      helpers.number_with_delimiter(data_at(row))
-    when 'Percentage'
-      helpers.number_to_percentage(data_at(row), precision: 2)
-    when 'Currency'
-      helpers.number_to_currency(data_at(row))
-    else
-      data_at(row)
-    end
-  end
-
-  def data_at(row)
-    @values[row]
-  end
-
-  private
-
-  def construct_values
-    Hash.new(@default)
-        .merge(@collection.send(*@grouping).send(*@agregate_function))
-        .merge({ 'TOTAL' => @collection.send(*@agregate_function) })
-  end
-
-  def helpers
-    ActionController::Base.helpers
-  end
-end

data/app/models/combined_column.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-# combined columns. can substract and create rates
-class CombinedColumn < Column
-  attr_accessor :columns
-
-  def initialize(args = {})
-    super(args)
-    @columns = args[:columns]
-    @method = args[:method]
-    @type = args[:type]
-    @label = args[:label]
-  end
-
-  def data_at(row)
-    combine(row)
-  end
-
-  private
-
-  def combine(row)
-    case @method
-    when 'rate'
-      columns[0].data_at(row).fdiv(columns[1].data_at(row)) * 100
-    when 'substract'
-      columns[0].data_at(row) - columns[1].data_at(row)
-    end
-  end
-
-  def construct_values; end
-
-  def helpers
-    ActionController::Base.helpers
-  end
-end

data/app/models/data_table.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# creates the datatable and it's columns
-class DataTable
-  attr_reader :columns, :rows, :labels
-
-  def initialize(columns, rows, grouping)
-    @grouping = grouping
-    @rows = rows + ['TOTAL']
-    @columns = treat_columns(columns)
-    @labels = @columns.map(&:label)
-  end
-
-  private
-
-  def treat_columns(columns)
-    convert_columns(columns)
-    columns.map! do |col|
-      if col.is_a?(CombinedColumn)
-        col.columns = columns.find_all { |col2| col.columns.include?(col2.label) }.sort do |column|
-          col.columns.index(column.label)
-        end
-      end
-      col
-    end
-  end
-
-  def convert_columns(columns)
-    columns.map! do |col|
-      if col[:column_type] == 'combined'
-        CombinedColumn.new(col)
-      else
-        Column.new(col.merge(grouping: @grouping))
-      end
-    end
-  end
-end