datagrid 1.8.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df8447e3bdc797a74cbbc4d7aac869bac6c0bcd57500d58bf14c1f3af5db7df9
-  data.tar.gz: aa0c1a716ad3a7054db53f7605222d1386b73a8378c0eaf3087fd60477361bd3
+  metadata.gz: d4f9903c41d2efb4c914ddf949db685228644e1ba071e8e2337491e0b91e0bbd
+  data.tar.gz: 937aea06689389c091b3be16aabaa36d8c828b8a8e97f220eaad403975371c6e
 SHA512:
-  metadata.gz: 9bffeed51b8a4d994136931096f5c7438243ad73c2c46540c7f20a2a542e25c6644b970ddc1e2fc10673de94b1d1f6a0d1892caf7cdc4fec38bde67324767508
-  data.tar.gz: d3ccf6646f9b8c21f0b8c2a81853294c9e8069c5a17644617c57d1de675be8bb380237aafb9f5b12e21ac49c909376bbf53d0d4e30e50a96387c070c8919fc59
+  metadata.gz: b3a5ef4923f03bd41bc54c2cc8ad6261f4a1e3302c4aad83a58868d539d69527a6cf838ee6efdf621fa0a47dabd023fa041773dde723f35f0feaf59e0b5effe6
+  data.tar.gz: 0a4c6aca85619ab3a71c125717d6f6f5209eafcb7a509df76afaac91e70790f199fea2ac796ebb9c05d088c8f4d40b42c16d6a49a28661ae1da7703c86c1ff92

data/.yardopts

@@ -0,0 +1,2 @@
+--markup=markdown
+--readme=README.md

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## master
+## 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
 

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,37 +15,42 @@ 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)
+
+## Datagrid Philosophy
 
-[Create an issue](https://github.com/bogdan/datagrid/issues/new) if you want more.
+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)
@@ -71,7 +79,7 @@ Basic grid api:
 
 ``` ruby
 report = UsersGrid.new(
-  group_id: [1,2], 
+  group_id: [1,2],
   logins_count: [1, nil],
   category: "first",
   order: :group,
@@ -79,7 +87,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   # => [
@@ -103,7 +114,8 @@ In order to create a report, you need to define:
 ### 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
@@ -111,7 +123,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
 
@@ -133,9 +145,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 
+* dynamic - build dynamic SQL condition
 
-[More about filters](https://github.com/bogdan/datagrid/wiki/Filters)
+[More about filters](https://rubydoc.info/gems/datagrid/Datagrid/Filters)
 
 ### Columns
 
@@ -150,11 +162,11 @@ end
 Some formatting options are also available.
 Each column is sortable.
 
-[More about columns](https://github.com/bogdan/datagrid/wiki/Columns)
+[More about columns](https://rubydoc.info/gems/datagrid/Datagrid/Columns)
 
 ### Front end
 
-### Using Generator
+#### Using Generator
 
 Datagrid has a builtin generator:
 
@@ -172,27 +184,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).
+If you are interested in contributing to this project,
+please follow the [instructions here](CONTRIBUTING.md).
 
 ## Self-Promotion
 
@@ -203,4 +217,5 @@ 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,12 +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" %>
-    <%= 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

@@ -12,26 +12,27 @@ Gem::Specification.new do |s|
   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",
+    ".yardopts",
   ]
   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",
+    "documentation_uri" => "https://rubydoc.info/gems/datagrid",
+    "changelog_uri" => "#{s.homepage}/blob/main/CHANGELOG.md",
     "source_code_uri" => s.homepage,
+    "rubygems_mfa_required" => "true",
   }
 
-  s.add_dependency "railties", ">= 6.1"
+  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

data/lib/datagrid/column_names_attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datagrid
   module ColumnNamesAttribute
     extend ActiveSupport::Concern
@@ -21,6 +23,7 @@ module Datagrid
       # will always present in the grid table and won't be listed
       # in column names selection
       # Accepts same options as <tt>:enum</tt> filter
+      # @return [Datagrid::Filters::BaseFilter] Defined filter object
       # @example
       #   column_names_filter(header: "Choose columns")
       # @see Datagrid::Filters::ClassMethods#filter
@@ -44,7 +47,7 @@ module Datagrid
     # If no mandatory columns specified than all of them considered mandatory
     # @return [Array<Datagrid::Columns::Column>]
     def mandatory_columns
-      available_columns.select {|c| c.mandatory? }
+      available_columns.select(&:mandatory?)
     end
 
     # Returns a list of enabled columns without <tt>mandatory: true</tt> option
@@ -57,7 +60,7 @@ module Datagrid
     protected
 
     def optional_columns_select
-      optional_columns.map {|c| [c.header, c.name] }
+      optional_columns.map { |c| [c.header, c.name] }
     end
 
     def selected_column_names(*args)
@@ -67,19 +70,15 @@ module Datagrid
           column.is_a?(Datagrid::Columns::Column) ? column.name : column.to_sym
         end
         args
+      elsif column_names&.any?
+        column_names + mandatory_columns.map(&:name)
       else
-        if column_names && column_names.any?
-          column_names + mandatory_columns.map(&:name)
-        else
-          columns_enabled_by_default.map(&:name)
-        end
+        columns_enabled_by_default.map(&:name)
       end
     end
 
     def columns_visibility_enabled?
-      columns_array.any? do |column|
-        column.mandatory_explicitly_set?
-      end
+      columns_array.any?(&:mandatory_explicitly_set?)
     end
 
     def columns_enabled_by_default
@@ -87,4 +86,3 @@ module Datagrid
     end
   end
 end
-