easy_data_tables 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 175851ae1970a77c3852ec84c03273bf471236d5d221287e4a52808d546baa11
-  data.tar.gz: 963dd66681346f045d2d0342244280ee8e39c47edff793683e9d70b4138efbde
+  metadata.gz: 3cb80cf6b75f6538198a91b5e47dda21b23d33f16ad59017e23601c19c1f7f4b
+  data.tar.gz: f157300ea30e55dee0fbf082c8da2e9e3681a7e19b6ebf39d56e71b1e3279820
 SHA512:
-  metadata.gz: d3c73640d78792ebcba8b6d77378f14f45e01e72d4e5d5f7ff38a4f67bcdf24ad71c3394237b952b6d9fabc2748a2da091102e4a0cd195638e0e0f5e7f4e3394
-  data.tar.gz: 34e061900219b92aeb9d1afba6c922c920b5c0922bae62de175c0401fa6890a8402275a42f72a09f5e93539015b0150258605df0e3e10674df95512450ce412d
+  metadata.gz: f9db24e2600639ee0f711be2e123e410af17922cbb793380f930c2c137681fd85e1237cfe00e5a262242578b217897296aceeac4ff2a0b28c8dfb4eec2bfa394
+  data.tar.gz: 5b069d81d97bf2c07efbac3e05065dc5357d95111e74a5a56dc0dcfedd37f82d16746e64609fff0f8400f8318fc8470cc53058126ed1ccbe86a1461246e78ae8

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.4

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in easy_data_tables.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,6 @@
 # EasyDataTables
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/easy_data_tables`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -22,17 +20,122 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Helper Method
+
+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.
+
+### Parameters
+
+#### Columns
+
+Columns are an array of hashes. There are two types of columns: 'normal' and 'combined'
+
+Normal column hashes accept the following keys: 
+
+- **label**: string, default: '' => will inform the label of the column on the table
+- **type**: string, default: 'Integer', options: 'Integer', 'Currency', 'Percentage' => will inform the formating of the column
+- **default**: any, default: 0 => Will inform the default when a value is not found
+- **collection**: ActiveRecord::Relation, **required** => The data of the column (e.g. User.where(active: true)- -
+- **agregate_function**: Array of symbols OR symbol, **required** => aggregate function to run (e.g. [:average, :expense] OR :count)
+- **column_type**: string => will inform the type of column to use
+
+Cobmbined column hashes accept the following keys: 
+
+- **label**: string, default: '' => will inform the label of the column on the table
+- **type**: string, default: 'Integer', options: 'Integer', 'Currency', 'Percentage' => will inform the formating of the column
+- **columns**: Array, **required** => Will inform the columns to combine (e.g. ['expenditure', 'user_count'])
+- **method**: string, options: 'rate', 'substract', **required** => how to combine the columns to produce the data cell value
+- **column_type**: string, **must be set to 'combined'** => will inform the type of column to use
+
+### Rows
+
+Here you must pass an Array of strings to inform the label of each row.
+
+### Grouping
+
+Array of strings where the first string is the grouping method you are calling and the rest are the arguments of said method **e.g.** ['group', 'users.full_name'}
+
+
+
+### Example: 
+
+```ruby
+easy_data_table(
+    [
+        {
+            label: 'user_count',
+            type: 'Integer',
+            collection: User.all,
+            agregate_function: :count
+         },
+         {
+            label: 'active_user_count',
+            type: 'Integer',
+            collection: User.where(active: true),
+            agregate_function: :count
+         },
+         {
+            label: 'active_user_expense',
+            type: 'Currency',
+            collection: Expense.joins(:user).where(users: {active: true})
+            agregate_function: [:sum, :total]
+          },
+          {
+            column_type: 'combined',
+            columns: ['active_user_count', 'user_count'],
+            method: 'rate',
+            label: 'active_user_rate'
+          }
+    ],
+    User.all.pluck(:status).uniq,
+    ['group', 'users.status']
+)
+            
+```
+will generate a table that looks like this: 
+
+|            | User count | Active user count | Active user expense | Active User Rate |
+|------------|------------|-------------------|---------------------|------------------|
+| Premium    | 10         | 8                 | 90 $                | 80 %             |
+| Freemium   | 5          | 3                 | 0 $                 | 60 %             |
+| Premium ++ | 3          | 1                 | 150 $               | 33.33 %          |
+
+The table has the classes : "table" and "datatable"
+
+in order to have correct looking column labels you must have a I18n file that will have: 
+
+```yaml
+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
+```
+
+On hover on a column label, you will have the title that appears as a tooltip. 
+
+
+
+## Contributing
 
-## Development
+In order to contribute, do not hesitate to fork the repository and submit a pull request. 
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Known to-dos: 
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- Test the codebase
+- Add more methods to combined columns
+- Add more types
+- As is now, a TOTAL row will be appended at the end, ideally we should be able to provide our own total if we want to overwrite it.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_data_tables.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pablocm90/easy_data_tables.
 
 
 ## License

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/app/helpers/table_helper.rb

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

data/app/models/column.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# Column class, we can access the formated data and the data of a particular cell
 class Column
   attr_reader :label
 
-  def initialize(args = {}) #values = {}, label = '', type = 'Integer')
+  # values = {}, label = '', type = 'Integer')
+  def initialize(args = {})
     @label = args[:label] || ''
     @type = args[:type] || 'Integer'
     @default = args[:default] || 0
@@ -13,7 +15,6 @@ class Column
     @values = construct_values
   end
 
-
   def formated_data_at(row)
     case @type
     when 'Integer'
@@ -31,13 +32,12 @@ class Column
     @values[row]
   end
 
-
   private
 
   def construct_values
     Hash.new(@default)
-      .merge(@collection.send(*@grouping).send(*@agregate_function))
-      .merge({ 'TOTAL' => @collection.send(*@agregate_function) })
+        .merge(@collection.send(*@grouping).send(*@agregate_function))
+        .merge({ 'TOTAL' => @collection.send(*@agregate_function) })
   end
 
   def helpers

data/app/models/combined_column.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-
+# combined columns. can substract and create rates
 class CombinedColumn < Column
   attr_accessor :columns
 
@@ -8,6 +8,8 @@ class CombinedColumn < Column
     super(args)
     @columns = args[:columns]
     @method = args[:method]
+    @type = args[:type]
+    @label = args[:label]
   end
 
   def data_at(row)

data/app/models/data_table.rb

@@ -1,24 +1,20 @@
+# 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"]
+    @rows = rows + ['TOTAL']
     @columns = treat_columns(columns)
     @labels = @columns.map(&:label)
   end
 
   private
 
-
   def treat_columns(columns)
-    columns.map! do |col|
-      if col[:column_type] == 'combined'
-        CombinedColumn.new(col)
-      else
-        Column.new(col.merge(grouping: @grouping))
-      end
-    end
+    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|
@@ -28,4 +24,14 @@ class DataTable
       col
     end
   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

data/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # This command will automatically be run when you run "rails" with Rails gems
 # installed from the root of your application.
 
@@ -8,7 +10,7 @@ APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
 
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
-require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
-require "rails/all"
-require "rails/engine/commands"
+require 'rails/all'
+require 'rails/engine/commands'

data/easy_data_tables.gemspec

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
 require_relative 'lib/easy_data_tables/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "easy_data_tables"
+  spec.name          = 'easy_data_tables'
   spec.version       = EasyDataTables::VERSION
-  spec.authors       = ["Pablo Curell"]
-  spec.email         = ["pablocm90@gmail.com"]
+  spec.authors       = ['Pablo Curell']
+  spec.email         = ['pablocm90@gmail.com']
 
-  spec.summary       = "Gem to easily create data tables"
-  spec.description   = "tbc"
-  spec.homepage      = "https://github.com/pablocm90/easy_data_tables"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Gem to easily create data tables'
+  spec.description   = 'Create fast tables based on the models of your db'
+  spec.homepage      = 'https://github.com/pablocm90/easy_data_tables'
+  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"
-  spec.metadata["changelog_uri"] = "https://github.com/pablocm90/easy_data_tables"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/pablocm90/easy_data_tables'
+  spec.metadata['changelog_uri'] = 'https://github.com/pablocm90/easy_data_tables'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

data/lib/easy_data_tables.rb

@@ -1,6 +1,8 @@
-require "easy_data_tables/version"
+# frozen_string_literal: true
+
+require 'easy_data_tables/version'
 # require "app/helpers/helper"
-require "easy_data_tables/engine"
+require 'easy_data_tables/engine'
 # require "easy_data_tables/models/column"
 # require "easy_data_tables/models/combined_column"
 

data/lib/easy_data_tables/engine.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module EasyDataTables
   class Engine < Rails::Engine
     isolate_namespace EasyDataTables
   end
-end
+end

data/lib/easy_data_tables/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: easy_data_tables
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pablo Curell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies: []
-description: tbc
+description: Create fast tables based on the models of your db
 email:
 - pablocm90@gmail.com
 executables: []
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -51,14 +52,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem to easily create data tables