dtb 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11f3bb28db8a362f2965bd97ceb195a4227b8370c4825bf41178d0147fb9e797
+  data.tar.gz: 19ac52baaceb47c289f75607a7e37586d16526992af8482d37222fa9d3164a36
+SHA512:
+  metadata.gz: b502f8d3de872c1eb4292d601041fa01a4d80a142aa275162618cc2c94c5daddc1224a49df9f67dee3ea629fbe2951de2221724155091be22080b7d5bcf580fb
+  data.tar.gz: b63ddc9dc45706edbdefe52020ab454058e0a42cae0ea64667bf5f52b4993f986deaeff56304bf32a001890f199b8497e1f68bed7bbbafd28e9bc12ed77c7f57

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3
+        bundler-cache: true
+    - name: Set up RubyGems credentials
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+    - name: Build and Publish to RubyGems
+      run: |
+        bundle exec rake build
+        gem push pkg/*.gem

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "3.1", "3.2", "3.3"]
+    name: "Tests on Ruby ${{ matrix.ruby }}"
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Test and lint
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.0

data/.yardopts

@@ -0,0 +1 @@
+--plugin activesupport-concern

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at foca@foca.io. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dtb.gemspec
+gemspec
+
+# Development/test gems.
+gem "debug"
+gem "rake"
+gem "minitest"
+gem "standard"
+
+# Documentation gems.
+gem "yard"
+gem "yard-activesupport-concern", "~> 0.0.1"

data/Gemfile.lock

@@ -0,0 +1,169 @@
+PATH
+  remote: .
+  specs:
+    dtb (1.0.0.rc1)
+      activemodel (>= 4.2, < 8.0)
+      activesupport (>= 4.2, < 8.0)
+      i18n
+      rack
+      railties (>= 4.2, < 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (7.1.3)
+      activesupport (= 7.1.3)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.11.2)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    nokogiri (1.16.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (3.0.9)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.2)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.33.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.59.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    stringio (3.1.0)
+    thor (1.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    yard (0.9.34)
+    yard-activesupport-concern (0.0.1)
+      yard (>= 0.8)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  arm64-darwin-22
+  universal-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  dtb!
+  minitest
+  rake
+  standard
+  yard
+  yard-activesupport-concern (~> 0.0.1)
+
+BUNDLED WITH
+   2.2.16

data/README.md

@@ -0,0 +1,46 @@
+# DTB, DataTable Builder
+
+DataTable Builder provides simple building blocks to build complex filterable
+queries and turn them into easy to render datatables using Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem "dtb"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dtb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [repo][]. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of conduct][].
+
+## Code of Conduct
+
+Everyone interacting in the DTB project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the [code of conduct][].
+
+[repo]: https://github.com/foca/dtb
+[code of conduct]: https://github.com/foca/dtb/blob/main/CODE_OF_CONDUCT.md

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+YARD::Rake::YardocTask.new
+
+require "standard/rake"
+
+task default: %i[test standard yard build]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dtb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dtb.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/dtb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dtb"
+  spec.version = DTB::VERSION
+  spec.authors = ["Nicolas Sanguinetti"]
+  spec.email = ["foca@foca.io"]
+
+  spec.summary = "Toolkit for building dynamic data tables in Rails"
+  spec.description = <<~DESC
+    DataTable Builder provides simple building blocks to build complex
+    filterable queries and turn them into easy to render datatables using
+    Rails.
+  DESC
+  spec.homepage = "https://github.com/foca/dtb"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2", "< 8.0"
+  spec.add_dependency "activemodel", ">= 4.2", "< 8.0"
+  spec.add_dependency "railties", ">= 4.2", "< 8.0"
+  spec.add_dependency "rack"
+  spec.add_dependency "i18n"
+end

data/lib/dtb/builds_data_table.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require_relative "has_options"
+
+module DTB
+  # This mixin provides a protocol for objects to quickly turn themselves into a
+  # {DataTable}. Objects implementing this must override {#to_data_table} to
+  # return a Hash of arguments compatible with {DataTable#initialize}.
+  #
+  # The default implementation, geared towards {Query} objects, will run the
+  # query and pass the results of the run method as the data table's rows.
+  #
+  # @see Query
+  module BuildsDataTable
+    extend ActiveSupport::Concern
+    include HasOptions
+
+    class_methods do
+      # Instantiates this object and then calls #to_data_table
+      #
+      # @param ... any arguments will be forwarded to the constructor.
+      # @return (see #to_data_table)
+      def to_data_table(...)
+        new(...).to_data_table
+      end
+    end
+
+    # @return [Hash<Symbol, Object>] a Hash of arguments to pass to
+    #   {DataTable#initialize}.
+    def to_data_table(*)
+      {rows: run, options: options}
+    end
+  end
+end

data/lib/dtb/column.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "query_builder"
+require_relative "has_options"
+require_relative "renderable"
+
+module DTB
+  # Columns represent each dimension of data that is shown to users when
+  # building a data table. These are normally displayed as columns in a
+  # traditional "table" element, but could easily be rendered as key-value
+  # pairs in a list of "card" components.
+  #
+  # == Rendering "cells" for a column
+  #
+  # Each column object can specify a renderer via {#render_with}, which you can
+  # then invoke with the row data as you're rendering. This is optional and the
+  # default renderer is +nil+, but it helps when using, e.g., view components to
+  # render a data table.
+  #
+  # @example
+  #   class SomeQuery < DTB::Query
+  #     column :name, render_with: NameCellComponent
+  #
+  #     option :render_with, default: "data_table"
+  #   end
+  #
+  #   # data_table partial:
+  #   <table>
+  #     ...
+  #     <tbody>
+  #       <% data_table.rows.each do |row| %>
+  #       <tr>
+  #         <% data_table.columns.renderable.each do |column| %>
+  #           <td><%= render column.renderer(row: row) %></td>
+  #         <% end %>
+  #       </tr>
+  #       <% end %>
+  #     </tbody>
+  #   </table>
+  #
+  class Column < QueryBuilder
+    include HasOptions
+    include Renderable
+
+    # @!group Options
+
+    # @!attribute [rw] database
+    #   Whether to affect the query or not. If this is false, this Column's
+    #   {#call} method does nothing (just returns its input). This is useful for
+    #   laying out purely presentational columns on data tables, such as actions
+    #   at the end of each row, or a checkbox at the start.
+    option :database, default: true, required: true
+
+    # @!endgroup
+
+    # Looks up the column's header in the i18n sources. If the column is
+    # attached to an object that implements +ActiveModel::Translation+, the
+    # string will search in:
+    #
+    #     {i18n_scope}.columns.{query_class}.{column_name}
+    #
+    # And on parent classes of +query_class+. Finally, if it's not found in any,
+    # or if the column is not attached to an +ActiveModel::Translation+, then it
+    # will attempt
+    #
+    #     columns.{column_name}
+    #
+    # If none of the attempted translations exists, it will default to an empty
+    # string.
+    #
+    # @return [String]
+    def header
+      i18n_lookup(:columns, default: "")
+    end
+
+    # @return [Boolean] whether this column actually affects the query or not.
+    # @see #database
+    def database?
+      options[:database]
+    end
+
+    # @visibility private
+    def evaluate?
+      options[:database] && super
+    end
+
+    # (see Renderable#rendering_options)
+    def rendering_options
+      {column: self}
+    end
+  end
+end