Documents how to forward methods to the view in README

antillas21 · antillas21 · commit d35ce3149aab · 2014-06-17T21:06:07.000-07:00
* Adds `Using view helpers` section to README to document how to allow
  using view helpers inside our classes.
diff --git a/README.md b/README.md
@@ -118,6 +118,8 @@ def data
 end
 ```
 
+[See here](#using-view-helpers) if you need to use view helpers in the returned 2d array, like `link_to`, `mail_to`, `resource_path`, etc.
+
 #### Get Raw Records
 ```ruby
 def get_raw_records
@@ -205,6 +207,36 @@ jQuery(document).ready(function() {
 
 ### Additional Notes
 
+#### Using view helpers
+
+Sometimes you'll need to use view helper methods like `link_to`, `h`, `mailto`, `edit_resource_path` in the returned JSON representation returned by the `data` method. 
+
+To have these methods available to be used, this is the way to go:
+
+```ruby
+class MyCustomDatatable < AjaxDatatablesRails::Base
+  # either define them one-by-one
+  def_delegator :@view, :link_to
+  def_delegator :@view, :h
+  def_delegator :@view, :mail_to
+  
+  # or define them in one pass
+  def_delegators :@view, :link_to, :h, :mailto, :edit_resource_path, :other_method
+  
+  # now, you'll have these methods available to be used anywhere
+  # example: mapping the 2d jsonified array returned.
+  def data
+    records.map do |record|
+      [
+        link_to(record.fname, edit_resource_path(record)),
+        mail_to(record.email),
+        # other attributes
+      ]
+    end
+  end
+end
+```
+
 #### Options
 
 An `AjaxDatatablesRails::Base` inherited class can accept an options hash at initialization. This provides room for flexibility when required. Example:
