diff --git a/app/views/datagrid/_head.html.erb b/app/views/datagrid/_head.html.erb
index ee5d89ed..de2f969b 100644
--- a/app/views/datagrid/_head.html.erb
+++ b/app/views/datagrid/_head.html.erb
@@ -9,7 +9,7 @@
# Adding HTML classes based on condition
"datagrid-order-active-asc": grid.ordered_by?(column, false),
"datagrid-order-active-desc": grid.ordered_by?(column, true),
- )
+ ).presence
) do %>
<%= column.header %>
<% if column.supports_order? && options[:order] -%>
diff --git a/app/views/datagrid/_table.html.erb b/app/views/datagrid/_table.html.erb
index 2e9273ec..88eeafbe 100644
--- a/app/views/datagrid/_table.html.erb
+++ b/app/views/datagrid/_table.html.erb
@@ -7,7 +7,7 @@ Local variables:
<% if grid.html_columns(*options[:columns]).any? %>
<%= tag.table class: 'datagrid-table', **options.fetch(:html, {}) do %>
- <%= datagrid_header(grid, options) %>
+ <%= datagrid_header(grid, **options) %>
<% if assets.any? %>
diff --git a/lib/datagrid/base.rb b/lib/datagrid/base.rb
index f904d16d..f9412418 100644
--- a/lib/datagrid/base.rb
+++ b/lib/datagrid/base.rb
@@ -14,8 +14,6 @@ module Datagrid
autoload :Helper
autoload :FormBuilder
- autoload :Renderer
-
autoload :Engine
# Main datagrid class allowing to define columns and filters on your objects
diff --git a/lib/datagrid/helper.rb b/lib/datagrid/helper.rb
index bc42a56b..74ca557d 100644
--- a/lib/datagrid/helper.rb
+++ b/lib/datagrid/helper.rb
@@ -16,7 +16,9 @@ module Helper
# <% end %>
#
def datagrid_value(grid, column, model)
- datagrid_renderer.format_value(grid, column, model)
+ column = grid.column_by_name(column) if column.is_a?(String) || column.is_a?(Symbol)
+
+ grid.html_value(column, self, model)
end
# @!visibility private
@@ -44,7 +46,14 @@ def datagrid_format_value(grid, column, model)
# assets = grid.assets.page(params[:page])
# datagrid_table(grid, assets, options)
def datagrid_table(grid, assets = grid.assets, **options)
- datagrid_renderer.table(grid, assets, **options)
+ _render_partial(
+ "table", options[:partials],
+ {
+ grid: grid,
+ options: options,
+ assets: assets,
+ },
+ )
end
# Renders HTML table header for given grid instance using columns defined in it
@@ -60,8 +69,15 @@ def datagrid_table(grid, assets = grid.assets, **options)
# Default: 'datagrid'.
# @param grid [Datagrid] grid object
# @return [String] HTML table header tag markup
- def datagrid_header(grid, options = {})
- datagrid_renderer.header(grid, options)
+ def datagrid_header(grid, opts = :__unspecified__, **options)
+ unless opts == :__unspecified__
+ Datagrid::Utils.warn_once("datagrid_header now requires ** operator when passing options.")
+ options.reverse_merge!(opts)
+ end
+ options[:order] = true unless options.key?(:order)
+
+ _render_partial("head", options[:partials],
+ { grid: grid, options: options },)
end
# Renders HTML table rows using given grid definition using columns defined in it.
@@ -84,7 +100,11 @@ def datagrid_header(grid, options = {})
# %td= row.project_name
# %td.project-status{class: row.status}= row.status
def datagrid_rows(grid, assets = grid.assets, **options, &block)
- datagrid_renderer.rows(grid, assets, **options, &block)
+ safe_join(
+ assets.map do |asset|
+ datagrid_row(grid, asset, **options, &block)
+ end.to_a,
+ )
end
# @return [String] renders ordering controls for the given column name
@@ -99,7 +119,8 @@ def datagrid_order_for(grid, column, options = {})
Put necessary code inline inside datagrid/head partial.
See built-in partial for example.
MSG
- datagrid_renderer.order_for(grid, column, options)
+ _render_partial("order_for", options[:partials],
+ { grid: grid, column: column },)
end
# Renders HTML for grid with all filters inputs and labels defined in it
@@ -116,7 +137,10 @@ def datagrid_order_for(grid, column, options = {})
def datagrid_form_with(**options)
raise ArgumentError, "datagrid_form_with block argument is invalid. Use form_with instead." if block_given?
- datagrid_renderer.form_with(**options)
+ grid = options[:model]
+ raise ArgumentError, "Grid has no available filters" if grid&.filters&.empty?
+
+ _render_partial("form", options[:partials], { grid: options[:model], options: options })
end
# Renders HTML for grid with all filters inputs and labels defined in it
@@ -131,7 +155,16 @@ def datagrid_form_with(**options)
# @return [String] form HTML tag markup
def datagrid_form_for(grid, options = {})
Datagrid::Utils.warn_once("datagrid_form_for is deprecated if favor of datagrid_form_with.")
- datagrid_renderer.form_for(grid, options)
+ _render_partial(
+ "form", options[:partials],
+ grid: grid,
+ options: {
+ method: :get,
+ as: grid.param_name,
+ local: true,
+ **options,
+ },
+ )
end
# Provides access to datagrid columns data.
@@ -154,8 +187,10 @@ def datagrid_form_for(grid, options = {})
# Last Name: <%= row.last_name %>
# @example
# <%= datagrid_row(grid, user, columns: [:first_name, :last_name, :actions]) %>
- def datagrid_row(grid, asset, ...)
- datagrid_renderer.row(grid, asset, ...)
+ def datagrid_row(grid, asset, **options, &block)
+ Datagrid::Helper::HtmlRow.new(self, grid, asset, options).tap do |row|
+ return capture(row, &block) if block_given?
+ end
end
# Generates an ascending or descending order url for the given column
@@ -164,7 +199,12 @@ def datagrid_row(grid, asset, ...)
# @param descending [Boolean] specifies order direction. Ascending if false, otherwise descending.
# @return [String] order layout HTML markup
def datagrid_order_path(grid, column, descending)
- datagrid_renderer.order_path(grid, column, descending, request)
+ column = grid.column_by_name(column)
+ query = request&.query_parameters || {}
+ ActionDispatch::Http::URL.path_for(
+ path: request&.path || "/",
+ params: query.merge(grid.query_params(order: column.name, descending: descending)),
+ )
end
# @!visibility private
@@ -182,8 +222,71 @@ def datagrid_column_classes(grid, column)
protected
- def datagrid_renderer
- Renderer.for(self)
+ def _render_partial(partial_name, partials_path, locals = {})
+ render({
+ partial: File.join(partials_path || "datagrid", partial_name),
+ locals: locals,
+ })
+ end
+
+ # Represents a datagrid row that provides access to column values for the given asset
+ # @example
+ # row = datagrid_row(grid, user)
+ # row.class # => Datagrid::Helper::HtmlRow
+ # row.first_name # => "Bogdan"
+ # row.grid # => Grid object
+ # row.asset # => User object
+ # row.each do |value|
+ # puts value
+ # end
+ class HtmlRow
+ include Enumerable
+
+ attr_reader :grid, :asset, :options
+
+ # @!visibility private
+ def initialize(renderer, grid, asset, options)
+ @renderer = renderer
+ @grid = grid
+ @asset = asset
+ @options = options
+ end
+
+ # @return [Object] a column value for given column name
+ def get(column)
+ @renderer.datagrid_value(@grid, column, @asset)
+ end
+
+ # Iterates over all column values that are available in the row
+ # param block [Proc] column value iterator
+ def each(&block)
+ (@options[:columns] || @grid.html_columns).each do |column|
+ block.call(get(column))
+ end
+ end
+
+ # @return [String] HTML row format
+ def to_s
+ @renderer.send(:_render_partial, "row", options[:partials], {
+ grid: grid,
+ options: options,
+ asset: asset,
+ },)
+ end
+
+ protected
+
+ def method_missing(method, *args, &blk)
+ if (column = @grid.column_by_name(method))
+ get(column)
+ else
+ super
+ end
+ end
+
+ def respond_to_missing?(method, include_private = false)
+ !!@grid.column_by_name(method) || super
+ end
end
end
end
diff --git a/lib/datagrid/renderer.rb b/lib/datagrid/renderer.rb
deleted file mode 100644
index e2fbbc6e..00000000
--- a/lib/datagrid/renderer.rb
+++ /dev/null
@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-require "action_view"
-
-module Datagrid
- # @!visibility private
- class Renderer
- def self.for(template)
- new(template)
- end
-
- def initialize(template)
- @template = template
- end
-
- def format_value(grid, column, asset)
- column = grid.column_by_name(column) if column.is_a?(String) || column.is_a?(Symbol)
-
- grid.html_value(column, @template, asset)
- end
-
- def form_for(grid, options = {})
- _render_partial(
- "form", options[:partials],
- grid: grid,
- options: {
- method: :get,
- as: grid.param_name,
- local: true,
- **options,
- },
- )
- end
-
- def form_with(**options)
- grid = options[:model]
- raise ArgumentError, "Grid has no available filters" if grid&.filters&.empty?
-
- _render_partial("form", options[:partials], { grid: options[:model], options: options })
- end
-
- def table(grid, assets, **options)
- _render_partial(
- "table", options[:partials],
- {
- grid: grid,
- options: options,
- assets: assets,
- },
- )
- end
-
- def header(grid, options = {})
- options[:order] = true unless options.key?(:order)
-
- _render_partial("head", options[:partials],
- { grid: grid, options: options },)
- end
-
- def rows(grid, assets = grid.assets, **options, &block)
- @template.safe_join(
- assets.map do |asset|
- row(grid, asset, **options, &block)
- end.to_a,
- )
- end
-
- def row(grid, asset, **options, &block)
- Datagrid::Helper::HtmlRow.new(self, grid, asset, options).tap do |row|
- return @template.capture(row, &block) if block_given?
- end
- end
-
- def order_for(grid, column, options = {})
- _render_partial("order_for", options[:partials],
- { grid: grid, column: column },)
- end
-
- def order_path(grid, column, descending, request)
- column = grid.column_by_name(column)
- query = request&.query_parameters || {}
- ActionDispatch::Http::URL.path_for(
- path: request&.path || "/",
- params: query.merge(grid.query_params(order: column.name, descending: descending)),
- )
- end
-
- private
-
- def _render_partial(partial_name, partials_path, locals = {})
- @template.render({
- partial: File.join(partials_path || "datagrid", partial_name),
- locals: locals,
- })
- end
- end
-
- module Helper
- # Represents a datagrid row that provides access to column values for the given asset
- # @example
- # row = datagrid_row(grid, user)
- # row.class # => Datagrid::Helper::HtmlRow
- # row.first_name # => "Bogdan"
- # row.grid # => Grid object
- # row.asset # => User object
- # row.each do |value|
- # puts value
- # end
- class HtmlRow
- include Enumerable
-
- attr_reader :grid, :asset, :options
-
- # @!visibility private
- def initialize(renderer, grid, asset, options)
- @renderer = renderer
- @grid = grid
- @asset = asset
- @options = options
- end
-
- # @return [Object] a column value for given column name
- def get(column)
- @renderer.format_value(@grid, column, @asset)
- end
-
- # Iterates over all column values that are available in the row
- # param block [Proc] column value iterator
- def each(&block)
- (@options[:columns] || @grid.html_columns).each do |column|
- block.call(get(column))
- end
- end
-
- def to_s
- @renderer.send(:_render_partial, "row", options[:partials], {
- grid: grid,
- options: options,
- asset: asset,
- },)
- end
-
- protected
-
- def method_missing(method, *args, &blk)
- if (column = @grid.column_by_name(method))
- get(column)
- else
- super
- end
- end
-
- def respond_to_missing?(method, include_private = false)
- !!@grid.column_by_name(method) || super
- end
- end
- end
-end
diff --git a/spec/datagrid/helper_spec.rb b/spec/datagrid/helper_spec.rb
index 37aaa345..6f88613f 100644
--- a/spec/datagrid/helper_spec.rb
+++ b/spec/datagrid/helper_spec.rb
@@ -724,6 +724,21 @@ def param_name
HTML
end
+
+ it "supports deprecated options passing" do
+ grid = test_grid_column(:name)
+ silence_deprecator do
+ expect(
+ subject.datagrid_header(grid, {order: false})
+ ).to equal_to_dom(<<~HTML)
+
+ |
+ Name
+ |
+
+ HTML
+ end
+ end
end
describe ".datagrid_column_classes" do
diff --git a/spec/support/test_partials/client/datagrid/_table.html.erb b/spec/support/test_partials/client/datagrid/_table.html.erb
index 84ff4665..336ce88b 100644
--- a/spec/support/test_partials/client/datagrid/_table.html.erb
+++ b/spec/support/test_partials/client/datagrid/_table.html.erb
@@ -7,7 +7,7 @@ Local variables:
Namespaced table partial.
<%= content_tag :table, options[:html] do %>
- <%= datagrid_header(grid, options) %>
+ <%= datagrid_header(grid, **options) %>
<% if assets.empty? %>