datagrid 1.8.1 → 2.0.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701bbc42a7501aa45a10d3899b92c9d1f745dae75b0a7eb219db1c339c182cb8
-  data.tar.gz: cb309f1b9f08b3c1455c1b8650cf222867ba68721a9eb344b310bc5d7d5712e4
+  metadata.gz: 37409811e25a50a023aa095fb8854424fea3867e137b8d212d619ba191307abe
+  data.tar.gz: 2485f8f3a8cf9d196011a584e680c345d147430ef3d263b151569ae10fc3ef69
 SHA512:
-  metadata.gz: 6bac4684420163514873a8a31bd06d182d216c8fff27f61d57368d605165838021a33d8603596ee04aee02e2b97a130308553bf36a8b6db0717f363b4c5ad472
-  data.tar.gz: 4f6190ffaadbf77d0bc39ca632de5df1bcd2ef716bff40a5074b48f710d8b2257e0a95759fe8465a756819deb5e9202abb92a64783eae2bd3804d6c5ddf02e8a
+  metadata.gz: 2974b76d03c7a3c014a3b853570ae0a11e2c137f0e4faea6be0dfcff45b49e4c64037298337e0f9e3028ecd64d938747770903469888339e6a43bbcc03330a59
+  data.tar.gz: 52d188d5c0e6a41a3f44061274695b5eee22f7c669c1814f26ae38cfeee364b66c8437ca85c55fa3a73d8fe3333e6c9820fda9b1e2ccee770d48bcba7d72bfe3

data/CHANGELOG.md

@@ -1,4 +1,24 @@
-## master
+# Changelog
+
+## 2.0.0
+
+Version 2 is a major update implementing a lot of major improvements
+at the cost of backward compatibility.
+
+[Changes and migration guide](./version-2)
+
+## 1.8.3
+
+* Fix rails hooking for version 7.1. [#327](https://github.com/bogdan/datagrid/issues/327)
+* Fix formatting of value for `date` and `datetime-local` input types
+
+## 1.8.2
+
+* Treat true/false as YES/NO when assigned as strings for xboolean filter.
+* Support infinite ranges for date, datetime and integer filters.
+* Treat `ActiveRecord::Result` class as `Array` driver.
+* Add `Datagrid#reset` method to reset a column cache.
+* Drop support of Rails 6.0 [#326](https://github.com/bogdan/datagrid/pull/326)
 
 ## 1.8.1
 
@@ -9,16 +29,20 @@
 * Support `input_options: {type: "textarea"}` as `<textarea/>` tag
 * Remove deprecated `eboolean` filter
 * Fixed scope wrapping to be universal
-* Deprecated `integer_range_filters` and `date_range_filters`. Use `filter(name, type, range: true)` instead.
-* Add `original_scope` method that returns scope as it was defined without any wrapping [#313](https://github.com/bogdan/datagrid/pull/313)
-* Add ability to specify `columns` option for `datagrid_row`. [#314](https://github.com/bogdan/datagrid/pull/314)
+* Deprecated `integer_range_filters` and `date_range_filters`.
+  Use `filter(name, type, range: true)` instead.
+* Add `original_scope` method that returns scope
+  as it was defined without any wrapping
+  [#313](https://github.com/bogdan/datagrid/pull/313)
+* Add ability to specify `columns` option for `datagrid_row`.
+  [#314](https://github.com/bogdan/datagrid/pull/314)
 
 ## 1.7.0
 
 * Depend on `railties` instead of `rails` to prevent loading of unnecessary frameworks
-* Bugfix `File.exist?` usage for ruby 3.0 [#307](https://github.com/bogdan/datagrid/issues/307)
-* Drop support of old Ruby versions (< 2.7)
-* Drop support of old Rails versions (< 6.0)
+* Bugfix `File.exist?` usage for Ruby 3.0 [#307](https://github.com/bogdan/datagrid/issues/307)
+* Drop support of old Ruby versions (< 2.7) [#305](https://github.com/bogdan/datagrid/pull/305)
+* Drop support of old Rails versions (< 6.0) [#305](https://github.com/bogdan/datagrid/pull/305)
 
 ## 1.6.3
 

data/{Readme.markdown → README.md}

@@ -1,10 +1,13 @@
 # Datagrid
 
-[![Build Status](https://github.com/bogdan/datagrid/workflows/CI/badge.svg?branch=master)](https://github.com/bogdan/datagrid/actions)
+Datagrid Version 2.0.0 is here.
 
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_shield)
+[Migration Guide](./version-2).
 
-A really mighty and flexible ruby library that generates reports including admin panels, analytics and data representation:
+[![Build Status](https://github.com/bogdan/datagrid/actions/workflows/ci.yml/badge.svg)](https://github.com/bogdan/datagrid/actions/workflows/ci.yml)
+
+A really mighty and flexible ruby library that generates reports
+including admin panels, analytics and data browsers:
 
 * Filtering
 * Columns
@@ -12,38 +15,44 @@ A really mighty and flexible ruby library that generates reports including admin
 * Localization
 * Export to CSV
 
-### ORM Support
+## ORM Support
 
 * ActiveRecord
 * Mongoid
 * MongoMapper
 * Sequel
-* Array (slow but possible)
+* Array (in-memory data of smaller scale)
 
 [Create an issue](https://github.com/bogdan/datagrid/issues/new) if you want more.
 
+## Datagrid Philosophy
+
+1. Expressive DSL complements OOD instead of replacing it.
+1. Extensible in every way while providing a lot of defaults.
+1. If your ORM supports that, datagrid also supports that!
 
-### Documentation
+## Documentation
 
-* [Readme](/Readme.markdown) - this read-me for basic information
-* [Wiki](https://github.com/bogdan/datagrid/wiki) - general reference on how to use the gem
-* [Rdoc](https://rubydoc.info/gems/datagrid) - API reference
+* [Rdoc](https://rubydoc.info/gems/datagrid) - full API reference
+* [Scope](https://rubydoc.info/gems/datagrid/Datagrid/Core) - working with datagrid scope
+* [Columns](https://rubydoc.info/gems/datagrid/Datagrid/Columns) - definging datagrid columns
+* [Filters](https://rubydoc.info/gems/datagrid/Datagrid/Filters) - defining datagrid filters
+* [Frontend](https://rubydoc.info/gems/datagrid/Datagrid/Helper) - building a frontend 
+* [Configuration](https://rubydoc.info/gems/datagrid/Datagrid/Configuration) - configuring the gem
 
 ### Live Demo
 
 [Datagrid DEMO application](http://datagrid.herokuapp.com) is available live!
 [Demo source code](https://github.com/bogdan/datagrid-demo).
 
-<img src="http://datagrid.herokuapp.com/datagrid_demo_screenshot.png" style="margin: 7px; border: 1px solid black">
+<!-- <img src="http://datagrid.herokuapp.com/datagrid_demo_screenshot.png" style="margin: 7px; border: 1px solid black"> -->
 
 ### Example
 
 In order to create a grid:
 
 ``` ruby
-class UsersGrid
-
-  include Datagrid
+class UsersGrid < Datagrid::Base
 
   scope do
     User.includes(:group)
@@ -72,7 +81,7 @@ Basic grid api:
 
 ``` ruby
 report = UsersGrid.new(
-  group_id: [1,2], 
+  group_id: [1,2],
   logins_count: [1, nil],
   category: "first",
   order: :group,
@@ -80,7 +89,10 @@ report = UsersGrid.new(
 )
 
 report.assets # => Array of User instances:
-              # SELECT * FROM users WHERE users.group_id in (1,2) AND users.logins_count >= 1 AND users.category = 'first' ORDER BY groups.name DESC
+              # SELECT * FROM users WHERE users.group_id in (1,2) AND
+              #   users.logins_count >= 1 AND
+              #   users.category = 'first'
+              # ORDER BY groups.name DESC
 
 report.header # => ["Name", "Group", "Activated"]
 report.rows   # => [
@@ -101,11 +113,11 @@ In order to create a report, you need to define:
 * filters that will be used to filter data
 * columns that should be displayed and sortable (if possible)
 
-
 ### Scope
 
 Default scope of objects to filter and display.
-In common case it is `ActiveRecord::Base` (or any other supported ORM) subclass with some generic scopes like:
+In common case it is `ActiveRecord::Base` (or any other supported ORM)
+subclass with some generic scopes like:
 
 ``` ruby
 scope do
@@ -113,7 +125,7 @@ scope do
 end
 ```
 
-[More about scope](https://github.com/bogdan/datagrid/wiki/Scope)
+[More about scope](https://rubydoc.info/gems/datagrid/Datagrid/Core)
 
 ### Filters
 
@@ -135,10 +147,9 @@ Datagrid supports different type of filters including:
 * xboolean - the select of "yes", "no" and any
 * enum - selection of the given values
 * string
-* dynamic - build dynamic SQL condition 
-
-[More about filters](https://github.com/bogdan/datagrid/wiki/Filters)
+* dynamic - build dynamic SQL condition
 
+[More about filters](https://rubydoc.info/gems/datagrid/Datagrid/Filters)
 
 ### Columns
 
@@ -157,7 +168,7 @@ Each column is sortable.
 
 ### Front end
 
-### Using Generator
+#### Using Generator
 
 Datagrid has a builtin generator:
 
@@ -175,23 +186,29 @@ route  resources :skills
 insert  app/assets/stylesheet/application.css
 ```
 
-### Customize Built-in partials
+#### Customize Built-in views
 
-In order to get a control on datagrid built-in partials run:
+In order to get a control on datagrid built-in views run:
 
 ``` sh
-rake datagrid:copy_partials
+rails g datagrid::views
 ```
 
-### Advanced frontend
+#### Advanced frontend
 
 All advanced frontend things are described in:
 
-[Frontend section on wiki](https://github.com/bogdan/datagrid/wiki/Frontend)
+[Frontend section on wiki](https://rubydoc.info/gems/datagrid/Datagrid/Helper)
 
 ## Questions & Issues
 
-If you have a question of any kind, just make an issue and describe your problem in details.
+If you have a question of any kind, just make an issue and
+describe your problem in details.
+
+## Contribution
+
+If you are interested in contributing to this project,
+please follow the [instructions here](CONTRIBUTING.md).
 
 ## Self-Promotion
 
@@ -201,6 +218,6 @@ Follow the repository on [GitHub](https://github.com/bogdan/datagrid).
 
 Read [author blog](http://gusiev.com).
 
-
 ## License
+
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_large)

data/app/assets/stylesheets/datagrid.css

@@ -0,0 +1,145 @@
+/* Table */
+
+table.datagrid-table {
+  background-color: transparent;
+  border-collapse: collapse;
+  max-width: 100%;
+}
+
+table.datagrid-table th {
+  background-color: #eee;
+  text-align: left;
+  vertical-align: top;
+}
+
+table.datagrid-table td,
+table.datagrid-table th {
+  border: 1px solid #d6d6d6;
+  padding: 5px 10px;
+}
+
+.datagrid-order-control-asc,
+.datagrid-order-control-desc {
+  text-decoration: none;
+  font-weight: normal;
+}
+
+.datagrid-order-active-asc,
+.datagrid-order-active-desc {
+  background-color: #fff7d5;
+}
+
+.datagrid-order-active-asc a.datagrid-order-control-asc,
+.datagrid-order-active-desc a.datagrid-order-control-desc {
+  font-weight: bold;
+  color: #d00;
+}
+
+.datagrid-no-results {
+  text-align: center;
+}
+
+/* Form */
+
+.datagrid-form {
+  background-color: #f0f0f0;
+  border-radius: 5px;
+  padding: 20px;
+}
+
+.datagrid-filter {
+  margin: 10px;
+}
+
+.datagrid-filter label {
+  width: 150px;
+  display: inline-block;
+}
+
+.datagrid-filter input, .datagrid-filter select {
+  border: 2px solid #ccc;
+  border-radius: 4px;
+  display: inline-block;
+  padding: 5px 12px;
+  width: 300px;
+}
+
+input.datagrid-range-from, input.datagrid-range-to {
+  width: 138px;
+}
+
+.datagrid-filter select[multiple] {
+  border: 2px solid #ccc;
+  border-radius: 5px;
+  height: 100px;
+}
+
+select.datagrid-dynamic-field {
+  width: 228px
+}
+
+select.datagrid-dynamic-operation {
+  margin-left: 7px;
+  width: 60px;
+}
+
+.datagrid-dynamic-value {
+  margin: 10px 0 0 154px;
+}
+
+.datagrid-range-separator {
+  display: inline-block;
+  margin: 6px 4px 0;
+}
+
+.datagrid-enum-checkboxes {
+  display: inline-block;
+}
+
+.datagrid-enum-checkboxes input {
+  margin: 7px;
+  width: auto;
+}
+
+.datagrid-enum-checkboxes label {
+  display: block;
+  width: 100%;
+}
+
+.datagrid-actions {
+  padding-left: calc(150px + 10px);
+}
+
+.datagrid-submit {
+  background-color: #555;
+  border: none;
+  border-radius: 5px;
+  color: white;
+  cursor: pointer;
+  font-size: 14px;
+  font-weight: bold;
+  line-height: normal;
+  padding: 7px 15px;
+  vertical-align: middle;
+  display: inline-block;
+  zoom: 1;
+  *display: inline;
+}
+
+.datagrid-submit:hover,
+.datagrid-submit:focus {
+  background-color: #333;
+}
+
+.datagrid-submit:active {
+  background-color: #000;
+}
+
+.datagrid-reset {
+  font-size: 14px;
+  padding: 7px 15px;
+  vertical-align: middle;
+  display: inline-block;
+  zoom: 1;
+  *display: inline;
+}

data/app/views/datagrid/_enum_checkboxes.html.erb

@@ -2,10 +2,12 @@
 Indent in this file may cause extra space to appear.
 You can add indent if whitespace doesn't matter for you
 %>
-<%- elements.each do |value, text, checked| -%>
+<div class="datagrid-enum-checkboxes">
+<%- choices.each do |value, text| -%>
 <%- id = [form.object_name, filter.name, value].join('_').underscore -%>
-<%= form.label filter.name, options.merge(for: id) do -%>
-<%= form.check_box(filter.name, {multiple: true, id: id, checked: checked, include_hidden: false}, value.to_s, nil) -%>
+<%= form.datagrid_label(filter.name, for: id, **options) do -%>
+<%= form.datagrid_filter_input(filter.name, id: id, value: value) -%>
 <%= text -%>
 <%- end -%>
 <%- end -%>
+</div>

data/app/views/datagrid/_form.html.erb

@@ -1,13 +1,12 @@
-<%= form_for grid, options do |f| -%>
+<%= form_with model: grid, html: {class: 'datagrid-form'}, scope: grid.param_name, method: :get, **options do |f| %>
   <% grid.filters.each do |filter| %>
-    <div class="datagrid-filter filter">
+    <div class="datagrid-filter" data-filter="<%= filter.name %>" data-type="<%= filter.type %>">
       <%= f.datagrid_label filter %>
       <%= f.datagrid_filter filter %>
     </div>
   <% end %>
   <div class="datagrid-actions">
-    <%= f.submit I18n.t("datagrid.form.search").html_safe, class: "datagrid-submit" %>
-    <%# https://github.com/rails/rails/pull/14949 -%>
-    <%= link_to I18n.t('datagrid.form.reset').html_safe, url_for(grid.to_param => {}), class: "datagrid-reset" %>
+    <%= f.submit I18n.t("datagrid.form.search"), class: "datagrid-submit" %>
+    <%= link_to I18n.t('datagrid.form.reset'), url_for(grid.to_param => {}), class: "datagrid-reset" %>
   </div>
 <% end -%>

data/app/views/datagrid/_head.html.erb

@@ -1,8 +1,31 @@
 <tr>
   <% grid.html_columns(*options[:columns]).each do |column| %>
-    <th class="<%= datagrid_column_classes(grid, column) %>">
+    <%= tag.th(
+      # Consider maintaining consistency with datagrid/rows partial
+      "data-column": column.name,
+      **column.tag_options,
+      class: [        
+        column.tag_options[:class],
+        # Adding HTML classes based on condition
+        "datagrid-order-active-asc": grid.ordered_by?(column, false),
+        "datagrid-order-active-desc": grid.ordered_by?(column, true),
+      ]
+    ) do %>
       <%= column.header %>
-      <%= datagrid_order_for(grid, column, options) if column.supports_order? && options[:order]%>
-    </th>
+      <% if column.supports_order? && options[:order] -%>
+        <div class="datagrid-order">
+          <%= link_to(
+            I18n.t("datagrid.table.order.asc"),
+            datagrid_order_path(grid, column, false),
+            class: "datagrid-order-control-asc"
+          ) %>
+          <%= link_to(
+            I18n.t("datagrid.table.order.desc"),
+            datagrid_order_path(grid, column, true),
+            class: "datagrid-order-control-desc"
+          ) %>
+        </div>
+      <% end -%>
+    <% end -%>
   <% end %>
 </tr>

data/app/views/datagrid/_range_filter.html.erb

@@ -1,3 +1,5 @@
-<%= form.datagrid_filter_input(filter, **from_options) %>
-<span class="separator <%= filter.type %>"><%= I18n.t('datagrid.filters.range.separator') %></span>
-<%= form.datagrid_filter_input(filter, **to_options) %>
+<%= form.datagrid_filter_input(filter, class: 'datagrid-range-from', **from_options) %>
+<span class="datagrid-range-separator"><%= I18n.t('datagrid.filters.range.separator') %></span>
+<%# Generating id only for "from" input to make sure -%>
+<%# there is no duplicate id in DOM and click on label focuses the first input -%>
+<%= form.datagrid_filter_input(filter, class: 'datagrid-range-to', **to_options, id: nil) %>

data/app/views/datagrid/_row.html.erb

@@ -1,5 +1,16 @@
 <tr>
   <% grid.html_columns(*options[:columns]).each do |column| %>
-    <td class="<%= datagrid_column_classes(grid, column) %>"><%= datagrid_value(grid, column, asset) %></td>
+    <%= tag.td(
+      datagrid_value(grid, column, asset),
+      # Consider maintaining consistency with datagrid/rows partial
+      "data-column": column.name,
+      **column.tag_options,
+      class: [ 
+        column.tag_options[:class],
+        # Adding HTML classes based on condition
+        "datagrid-order-active-asc": grid.ordered_by?(column, false),
+        "datagrid-order-active-desc": grid.ordered_by?(column, true),
+      ]
+    ) %>
   <% end %>
 </tr>

data/app/views/datagrid/_table.html.erb

@@ -5,18 +5,18 @@ Local variables:
 * options - passed options Hash
 %>
 <% if grid.html_columns(*options[:columns]).any? %>
-  <%= content_tag :table, options[:html] do %>
+  <%= tag.table class: 'datagrid-table', **options.fetch(:html, {}) do %>
     <thead>
-      <%= datagrid_header(grid, options) %>
+      <%= datagrid_header(grid, **options) %>
     </thead>
     <tbody>
       <% if assets.any? %>
         <%= datagrid_rows(grid, assets, **options) %>
       <% else %>
-        <tr><td class="noresults" colspan="100%"><%= I18n.t('datagrid.no_results').html_safe %></td></tr>
+        <tr><td class="datagrid-no-results" colspan="100%"><%= I18n.t('datagrid.no_results') %></td></tr>
       <% end %>
     </tbody>
   <% end %>
 <% else -%>
-  <%= I18n.t("datagrid.table.no_columns").html_safe %>
+  <%= I18n.t("datagrid.table.no_columns") %>
 <% end %>

data/datagrid.gemspec

@@ -7,31 +7,31 @@ Gem::Specification.new do |s|
   s.version = Datagrid::VERSION
   s.require_paths = ["lib"]
   s.authors = ["Bogdan Gusiev"]
-  s.summary = "Ruby gem to create datagrids"
-  s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters"
+  s.summary = "Library that provides DSL to present table like data"
+  s.description = "The library allows you to easily build datagrid aka data tables with sortable columns and filters"
   s.email = "agresso@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "Readme.markdown"
+    "README.md",
   ]
   s.files = [
     "LICENSE.txt",
     "CHANGELOG.md",
-    "Readme.markdown",
+    "README.md",
     "datagrid.gemspec",
   ]
   s.files += `git ls-files | grep -E '^(app|lib|templates)'`.split("\n")
   s.homepage = "https://github.com/bogdan/datagrid"
   s.licenses = ["MIT"]
-  s.required_ruby_version = Gem::Requirement.new(">= 2.7")
+  s.required_ruby_version = Gem::Requirement.new(">= 3.0")
   s.metadata = {
     "homepage_uri" => s.homepage,
     "bug_tracker_uri" => "#{s.homepage}/issues",
     "documentation_uri" => "#{s.homepage}/wiki",
-    "changelog_uri" => "#{s.homepage}/blob/master/CHANGELOG.md",
+    "changelog_uri" => "#{s.homepage}/blob/main/CHANGELOG.md",
     "source_code_uri" => s.homepage,
+    "rubygems_mfa_required" => "true",
   }
 
-  s.add_dependency "railties", ">= 6.0"
+  s.add_dependency "railties", ">= 7.0"
 end
-

data/lib/datagrid/active_model.rb

@@ -1,27 +1,19 @@
+# frozen_string_literal: true
+
 module Datagrid
   # Required to be ActiveModel compatible
   module ActiveModel
-    # @!visibility private
-    def self.included(base)
-      base.extend         ClassMethods
-      base.class_eval do
-        begin
-          require 'active_model/naming'
-          extend ::ActiveModel::Naming
-        rescue LoadError
-        end
-        begin
-          require 'active_model/attributes_assignment'
-          extend ::ActiveModel::AttributesAssignment
-        rescue LoadError
-        end
-      end
+    extend ActiveSupport::Concern
+
+    included do
+      require "active_model/naming"
+      extend ::ActiveModel::Naming
     end
 
     module ClassMethods
       # @return [String] URL query parameter name of the grid class
       def param_name
-        self.to_s.underscore.tr('/', '_')
+        to_s.underscore.tr("/", "_")
       end
     end
 
@@ -48,7 +40,7 @@ module Datagrid
     end
 
     def to_param
-      self.param_name
+      param_name
     end
   end
 end

data/lib/datagrid/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Datagrid
+  extend ActiveSupport::Autoload
+
+  autoload :Core
+  autoload :ActiveModel
+  autoload :Filters
+  autoload :Columns
+  autoload :ColumnNamesAttribute
+  autoload :Ordering
+  autoload :Configuration
+
+  autoload :Helper
+  autoload :FormBuilder
+
+  autoload :Engine
+
+  # Main datagrid class allowing to define columns and filters on your objects
+  #
+  # @example
+  #   class UsersGrid < Datagrid::Base
+  #     scope { User }
+  #
+  #     filter(:id, :integer)
+  #     filter(:name, :string)
+  #
+  #     column(:id)
+  #     column(:name)
+  #   end
+  class Base
+    include ::Datagrid::Core
+    include ::Datagrid::ActiveModel
+    include ::Datagrid::Filters
+    include ::Datagrid::Columns
+    include ::Datagrid::ColumnNamesAttribute
+    include ::Datagrid::Ordering
+  end
+end