Add ability to rendeer specific row with specific columns. bogdan#314

Author: bogdan

lib/datagrid/columns.rb

@@ -446,8 +446,8 @@ def generic_value(column, model)
 
       protected
 
-      def append_column_preload(scope)
-        columns.inject(scope) do |current, column|
+      def append_column_preload(relation)
+        columns.inject(relation) do |current, column|
           column.append_preload(current)
         end
       end

lib/datagrid/columns/column.rb

@@ -133,17 +133,17 @@ def generic_value(model, grid)
     grid.generic_value(self, model)
   end
 
-  def append_preload(scope)
-    return scope unless preload
+  def append_preload(relation)
+    return relation unless preload
     if preload.respond_to?(:call)
-      return scope unless preload
+      return relation unless preload
       if preload.arity == 1
-        preload.call(scope)
+        preload.call(relation)
       else
-        scope.instance_exec(&preload)
+        relation.instance_exec(&preload)
       end
     else
-      driver.default_preload(scope, preload)
+      driver.default_preload(relation, preload)
     end
   end
 

lib/datagrid/helper.rb

@@ -52,6 +52,9 @@ def datagrid_table(grid, assets = grid.assets, **options)
     #
     # * <tt>:order</tt> - display ordering controls built-in into header
     #   Default: true
+    # * <tt>:columns</tt> - Array of column names to display.
+    #   Used in case when same grid class is used in different places
+    #   and needs different columns. Default: all defined columns.
     # * <tt>:partials</tt> - Path for partials lookup.
     #   Default: 'datagrid'.
     # @param grid [Datagrid] grid object
@@ -124,12 +127,10 @@ def datagrid_form_for(grid, options = {})
     #   <% row = datagrid_row(grid, user) %>
     #   First Name: <%= row.first_name %>
     #   Last Name: <%= row.last_name %>
-    def datagrid_row(grid, asset, &block)
-      HtmlRow.new(self, grid, asset).tap do |row|
-        if block_given?
-          return capture(row, &block)
-        end
-      end
+    # @example
+    #   <%= datagrid_row(grid, user, columns: [:first_name, :last_name, :actions]) %>
+    def datagrid_row(grid, asset, **options, &block)
+      datagrid_renderer.row(grid, asset, **options, &block)
     end
 
     # Generates an ascending or descending order url for the given column
@@ -141,51 +142,6 @@ def datagrid_order_path(grid, column, descending)
       datagrid_renderer.order_path(grid, column, descending, request)
     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 # => "<strong>Bogdan</strong>"
-    #   row.grid       # => Grid object
-    #   row.asset      # => User object
-    #   row.each do |value|
-    #     puts value
-    #   end
-    class HtmlRow
-
-      include Enumerable
-
-      attr_reader :grid, :asset
-
-      # @!visibility private
-      def initialize(context, grid, asset)
-        @context = context
-        @grid = grid
-        @asset = asset
-      end
-
-      # @return [Object] a column value for given column name
-      def get(column)
-        @context.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)
-        @grid.columns.each do |column|
-          block.call(get(column))
-        end
-      end
-
-      protected
-      def method_missing(method, *args, &blk)
-        if column = @grid.column_by_name(method)
-          get(column)
-        else
-          super
-        end
-      end
-    end
 
     protected
 

lib/datagrid/renderer.rb

@@ -56,22 +56,20 @@ def header(grid, options = {})
 
     def rows(grid, assets = grid.assets, **options, &block)
       result = assets.map do |asset|
-        if block_given?
-          @template.capture do
-            yield(Datagrid::Helper::HtmlRow.new(@template, grid, asset))
-          end
-        else
-          _render_partial( 'row', options[:partials], {
-            :grid => grid,
-            :options => options,
-            :asset => asset
-          })
-        end
+        row(grid, asset, **options, &block)
       end.to_a.join
 
       _safe(result)
     end
 
+    def row(grid, asset, **options, &block)
+      Datagrid::Helper::HtmlRow.new(self, grid, asset, options).tap do |row|
+        if block_given?
+          return @template.capture(row, &block)
+        end
+      end
+    end
+
     def order_for(grid, column, options = {})
       _render_partial('order_for', options[:partials],
                       { :grid => grid, :column => column })
@@ -99,4 +97,61 @@ def _render_partial(partial_name, partials_path, 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 # => "<strong>Bogdan</strong>"
+    #   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
+    end
+  end
 end

spec/datagrid/helper_spec.rb

@@ -613,6 +613,11 @@ def param_name
       expect(data_row.random2).to_not eq(html_row.random1)
     end
 
+    it "converts to string using columns option" do
+      r = subject.datagrid_row(grid, entry, columns: [:name]).to_s
+      expect(r).to match_css_pattern('tr td.name')
+      expect(r).to_not match_css_pattern('tr td.category')
+    end
   end
 
   describe ".datagrid_value" do

spec/support/matchers.rb

@@ -71,7 +71,6 @@ def matches?(text)
         expected_amount = amount_or_pattern_or_string_or_proc
         amount = path.size
         if amount != expected_amount
-          puts text
           return error!("did not find #{css.inspect} #{expected_amount.inspect} times. It was #{amount.inspect}")
         end
       elsif amount_or_pattern_or_string_or_proc.is_a? Proc