Merge pull request #17 from matestack/20210603_issue#11_fix_custom_rendering_per_column

enable slot usage per column, added specs and docs for row object …

Author: jonasjabari

docs/api/components/smart_collection.md

@@ -10,7 +10,7 @@ Docs in progress! Please review the examples.
 
 ## Examples
 
-### Example 1: Table rendering with custom row actions
+### Table rendering with custom row actions
 
 ```ruby
 def response
@@ -72,7 +72,7 @@ def customer_delete_action_config customer
 end
 ```
 
-### Example 2: Table rendering with joined model and formatted col data rendering
+### Table rendering with joined model and formatted col data rendering
 
 ```ruby
 def response
@@ -119,7 +119,101 @@ def table_item_actions order
 end
 ```
 
-### Example 3: Custom collection rendering
+### Table rendering formatted col data rendering access the whole row instance object
+
+```ruby
+def response
+  #...
+  bs_smart_collection collection_config
+  #...
+end
+
+def collection_config
+  {
+    id: 'orders',
+    items: Order.all,
+    paginate: 10,
+    rerender_on: "success",
+    columns: {
+      self: {
+        heading: 'Price in €',
+        format: -> (order){ "#{order.price_in_euro} €" },
+      }
+    }
+  }
+end
+```
+
+### Table rendering formatted col data rendering access the whole row instance object in multiple columns
+
+```ruby
+def response
+  #...
+  bs_smart_collection collection_config
+  #...
+end
+
+def collection_config
+  {
+    id: 'orders',
+    items: Order.all,
+    paginate: 10,
+    rerender_on: "success",
+    # the columns hash can only have a key once, fix by specifying the attribute name
+    columns: {
+      price_in_euro: {
+        heading: 'Price in €',
+        format: -> (column_data){ "#{column_data} €" },
+      },
+      price_in_euro_again: {
+        attribute: :price_in_euro, # fix by specifying the attribute name
+        heading: 'Price in €',
+        format: -> (column_data){ "#{column_data} €" },
+      },
+      self: {
+        heading: 'Price in €',
+        format: -> (order){ "#{order.price_in_euro} €" },
+      },
+      self_again: {
+        attribute: :self, # fix by specifying the attribute name
+        heading: 'Price in €',
+        format: -> (order){ "#{order.price_in_euro} €" },
+      }
+    }
+  }
+end
+```
+
+### Table rendering via slot enabling flexible column content composition
+
+```ruby
+def response
+  #...
+  bs_smart_collection collection_config
+  #...
+end
+
+def collection_config
+  {
+    id: 'orders',
+    items: Order.all,
+    paginate: 10,
+    rerender_on: "success",
+    columns: {
+      price_in_euro: {
+        heading: 'Price in € accessed via row object',
+        slot: method(:price_in_euro_column_slot) # slots ALWAYS get the whole row object passed in!
+      }
+    }
+  }
+end
+
+def price_in_euro_column_slot order
+  bs_badge order.price_in_euro # or whatever you want to do with all kinds of components
+end
+```
+
+### Custom collection rendering
 
 ```ruby
 def response
@@ -183,4 +277,3 @@ def product_delete_action_config product
   }
 end
 ```
-

lib/matestack/ui/bootstrap/content/smart_collection/content.rb

@@ -69,7 +69,11 @@ def table_footer
 
   def cell(data, key, value)
     td class: cell_class(value) do
-      plain cell_text(data, key, value)
+      if value.is_a?(Hash) && value[:slot]
+        value[:slot].call(data)
+      else
+        plain cell_text(data, key, value)
+      end
     end
   end
 
@@ -81,8 +85,17 @@ def cell_class(value)
   end
 
   def cell_text(data, key, value)
-    text = data.instance_eval(key.to_s)
-    text = value[:format].call(text) if value.is_a?(Hash) && value[:format]
+    if value.is_a?(Hash)
+      if value[:attribute].present?
+        text = data.instance_eval(value[:attribute].to_s)
+      else
+        text = data.instance_eval(key.to_s)
+      end
+      text = value[:format].call(text) if value[:format].present?
+    else
+      text = data.instance_eval(key.to_s)
+    end
+
     text
   end