在 Rails 应用程序中转换 Javascript 数据表以使用 Opal
Posted
技术标签:
【中文标题】在 Rails 应用程序中转换 Javascript 数据表以使用 Opal【英文标题】：Converting Javascript datatables to use Opal in Rails app 【发布时间】：2019-09-05 16:53:25 【问题描述】：我正在使用ajax-datatables-rails。下面是我的数据表的 JS。我想将 javascript 转换为等效的 Opal.rb。
jQuery(document).ready(function()
var table = $('#organizations-datatable');
var token = $('meta[name=csrf-token]').attr('content');
table.DataTable(
"processing": true,
"serverSide": true,
"ajax":
"url": "/organizations/datatable.json",
"type": 'POST',
"beforeSend": function (xhr)
xhr.setRequestHeader('X-CSRF-Token', token)
,
"pagingType": "full_numbers",
"destroy": true,
"columns": [
"data": "name",
"data": "desc",
"data": "industry",
"data": "tags"
],
"iDisplayLength": 25
);
);
它包括将 CSRF 令牌添加到 ajax 数据请求中。
为了便于阅读，我希望我们所有的 javascript 都写成 opal
下面的 Opal 和上面的 JS 实现的不一样。谁能帮我理解为什么？
Element.expose :DataTable
Document.ready? do
token = Element['meta[name=csrf-token]'].attr('content');
settings =
"processing": true,
"serverSide": true,
"ajax":
"url": "/organizations/datatable.json",
"type": 'POST',
"beforeSend": lambda do
xhr = `new window.XMLHttpRequest()`
xhr.setRequestHeader('X-CSRF-Token', token)
end
,
"pagingType": "full_numbers",
"destroy": true,
"columns": [
"data": "name",
"data": "desc",
"data": "industry",
"data": "tags"
]
Element['#organizations-datatable'].DataTable(settings.to_n)
end
我在这里缺少什么？为什么这个蛋白石不好？
编辑：这就是我的路线，这可以确保 POST 对此有效：
Rails.application.routes.draw do
concern :with_datatable do
post 'datatable', on: :collection
end
resources :organizations, concerns: [:with_datatable]
end
这是我使用 gem 的相关控制器和数据表代码：
class OrganizationsController < ApplicationController
def index
@title = "Organizations"
@page_description = "Organization data warehouse"
@page_icon = "institution"
@organization = Organization.new
@load = data_table: true
@menu = Menu.new
respond_to do |format|
format.html
format.json render json: OrganizationDatatable.new(params)
end
end
def datatable
logger.ap "datatable params: #params"
respond_to do |format|
format.json render json: OrganizationDatatable.new(params)
end
end
def get_raw_records
Organization.all
end
def create
end
def edit
end
def destroy
end
def show
end
def update
end
def new
end
end
这是数据表
class OrganizationDatatable < AjaxDatatablesRails::ActiveRecord
extend Forwardable
include ActionView::Helpers::TextHelper
def_delegator :@view, :link_to
def view_columns
# Declare strings in this format: ModelName.column_name
# or in aliased_join_table.column_name format
@view_columns ||=
# id: source: "Organization.id" ,
name: source: "Organization.name",cond: :like, searchable: true, orderable: true ,
desc: source: "Organization.description",cond: :like, searchable: true, orderable: true ,
industry: source: "Organization.industry",cond: :like, searchable: true, orderable: true ,
tags: source: "Organization.tag_list", searchable: false, orderable: false
end
def data
records.map do |record|
id: record.id,
name: record.name,
desc: truncate(record.description,length: 240, separator: ' '),
industry: record.industry,
tags: record.decorate.buttonize_tags,
DT_RowId: record.id
end
end
def get_raw_records
Organization.all
end
end
【问题讨论】：
这两个结果有什么区别？我建议您设置binding.pry 并检查 Opal 脚本中的每个变量值
究竟是什么工作不正常？会不会和beforeSend有关？
数据表未填充。是的。它基本上是 JS 中的 3 行代码和 Opal 中的 5 行代码。我看不出有什么错误。我看到控制台中没有任何错误。
您发布的问题中不包含该问题。您需要添加更多信息并更好地解决此问题。目前，您猜测问题出在这 3 行 Opal 代码中，但在您正确排除故障之前，您一无所知。尝试创建一个简单的Opal 示例并查看它是否有效，然后尝试使用Opal 为DataTable 对象编码console.log...并逐步添加功能，直到您确切地看到什么中断以便您清楚正在发生的事情的线索..否则我们只能尝试猜测。
您遇到了一个难以解决的静默错误。 Javascript 中哪些可能导致静默错误的错误？
【参考方案1】：
我将首先指出您的代码中的一些错误，
beforeSend中的代码有问题请参考supplying-an-xhr-method，改成如下代码，
"beforeSend": lambda do |xhr|
`xhr.setRequestHeader('X-CSRF-Token', token)`
将 xhr 语句括在 (`) 反引号中，如上述语句
列应该是二维数组而不是对象数组，
"columns": [
["data": "name"],
["data": "desc"],
["data": "industry"],
["data": "tags"]
]
其余代码看起来不错。
下面是测试代码，
Element.expose :DataTable
Document.ready? do
token = Element['meta[name=csrf-token]'].attr('content');
settings =
"ajax":
"url": "/data.json",
"type": 'POST',
"beforeSend": lambda do |xhr|
`xhr.setRequestHeader('X-CSRF-Token', token)`
end
,
"pagingType": "full_numbers",
"destroy": true,
"columns": [
["data": "Name"],
["data": "Position"],
["data": "Office"],
["data": "Extn."],
["data": "Start"],
["data": "Salary"]
]
Element['#organizations-datatable'].DataTable(settings.to_n)
end
确保rails app的public文件夹中有data.json文件，内容如下，
"data": [
[
"Tiger Nixon",
"System Architect",
"Edinburgh",
"5421",
"2011/04/25",
"$320,800"
],
[
"Garrett Winters",
"Accountant",
"Tokyo",
"8422",
"2011/07/25",
"$170,750"
],
[
"Ashton Cox",
"Junior Technical Author",
"San Francisco",
"1562",
"2009/01/12",
"$86,000"
],
[
"Cedric Kelly",
"Senior Javascript Developer",
"Edinburgh",
"6224",
"2012/03/29",
"$433,060"
],
[
"Airi Satou",
"Accountant",
"Tokyo",
"5407",
"2008/11/28",
"$162,700"
],
[
"Brielle Williamson",
"Integration Specialist",
"New York",
"4804",
"2012/12/02",
"$372,000"
],
[
"Herrod Chandler",
"Sales Assistant",
"San Francisco",
"9608",
"2012/08/06",
"$137,500"
],
[
"Rhona Davidson",
"Integration Specialist",
"Tokyo",
"6200",
"2010/10/14",
"$327,900"
],
[
"Colleen Hurst",
"Javascript Developer",
"San Francisco",
"2360",
"2009/09/15",
"$205,500"
],
[
"Sonya Frost",
"Software Engineer",
"Edinburgh",
"1667",
"2008/12/13",
"$103,600"
],
[
"Jena Gaines",
"Office Manager",
"London",
"3814",
"2008/12/19",
"$90,560"
],
[
"Quinn Flynn",
"Support Lead",
"Edinburgh",
"9497",
"2013/03/03",
"$342,000"
],
[
"Charde Marshall",
"Regional Director",
"San Francisco",
"6741",
"2008/10/16",
"$470,600"
],
[
"Haley Kennedy",
"Senior Marketing Designer",
"London",
"3597",
"2012/12/18",
"$313,500"
],
[
"Tatyana Fitzpatrick",
"Regional Director",
"London",
"1965",
"2010/03/17",
"$385,750"
],
[
"Michael Silva",
"Marketing Designer",
"London",
"1581",
"2012/11/27",
"$198,500"
],
[
"Paul Byrd",
"Chief Financial Officer (CFO)",
"New York",
"3059",
"2010/06/09",
"$725,000"
],
[
"Gloria Little",
"Systems Administrator",
"New York",
"1721",
"2009/04/10",
"$237,500"
],
[
"Bradley Greer",
"Software Engineer",
"London",
"2558",
"2012/10/13",
"$132,000"
],
[
"Dai Rios",
"Personnel Lead",
"Edinburgh",
"2290",
"2012/09/26",
"$217,500"
],
[
"Jenette Caldwell",
"Development Lead",
"New York",
"1937",
"2011/09/03",
"$345,000"
],
[
"Yuri Berry",
"Chief Marketing Officer (CMO)",
"New York",
"6154",
"2009/06/25",
"$675,000"
],
[
"Caesar Vance",
"Pre-Sales Support",
"New York",
"8330",
"2011/12/12",
"$106,450"
],
[
"Doris Wilder",
"Sales Assistant",
"Sidney",
"3023",
"2010/09/20",
"$85,600"
],
[
"Angelica Ramos",
"Chief Executive Officer (CEO)",
"London",
"5797",
"2009/10/09",
"$1,200,000"
],
[
"Gavin Joyce",
"Developer",
"Edinburgh",
"8822",
"2010/12/22",
"$92,575"
],
[
"Jennifer Chang",
"Regional Director",
"Singapore",
"9239",
"2010/11/14",
"$357,650"
],
[
"Brenden Wagner",
"Software Engineer",
"San Francisco",
"1314",
"2011/06/07",
"$206,850"
],
[
"Fiona Green",
"Chief Operating Officer (COO)",
"San Francisco",
"2947",
"2010/03/11",
"$850,000"
],
[
"Shou Itou",
"Regional Marketing",
"Tokyo",
"8899",
"2011/08/14",
"$163,000"
],
[
"Michelle House",
"Integration Specialist",
"Sidney",
"2769",
"2011/06/02",
"$95,400"
],
[
"Suki Burks",
"Developer",
"London",
"6832",
"2009/10/22",
"$114,500"
],
[
"Prescott Bartlett",
"Technical Author",
"London",
"3606",
"2011/05/07",
"$145,000"
],
[
"Gavin Cortez",
"Team Leader",
"San Francisco",
"2860",
"2008/10/26",
"$235,500"
],
[
"Martena Mccray",
"Post-Sales support",
"Edinburgh",
"8240",
"2011/03/09",
"$324,050"
],
[
"Unity Butler",
"Marketing Designer",
"San Francisco",
"5384",
"2009/12/09",
"$85,675"
],
[
"Howard Hatfield",
"Office Manager",
"San Francisco",
"7031",
"2008/12/16",
"$164,500"
],
[
"Hope Fuentes",
"Secretary",
"San Francisco",
"6318",
"2010/02/12",
"$109,850"
],
[
"Vivian Harrell",
"Financial Controller",
"San Francisco",
"9422",
"2009/02/14",
"$452,500"
],
[
"Timothy Mooney",
"Office Manager",
"London",
"7580",
"2008/12/11",
"$136,200"
],
[
"Jackson Bradshaw",
"Director",
"New York",
"1042",
"2008/09/26",
"$645,750"
],
[
"Olivia Liang",
"Support Engineer",
"Singapore",
"2120",
"2011/02/03",
"$234,500"
],
[
"Bruno Nash",
"Software Engineer",
"London",
"6222",
"2011/05/03",
"$163,500"
],
[
"Sakura Yamamoto",
"Support Engineer",
"Tokyo",
"9383",
"2009/08/19",
"$139,575"
],
[
"Thor Walton",
"Developer",
"New York",
"8327",
"2013/08/11",
"$98,540"
],
[
"Finn Camacho",
"Support Engineer",
"San Francisco",
"2927",
"2009/07/07",
"$87,500"
],
[
"Serge Baldwin",
"Data Coordinator",
"Singapore",
"8352",
"2012/04/09",
"$138,575"
],
[
"Zenaida Frank",
"Software Engineer",
"New York",
"7439",
"2010/01/04",
"$125,250"
],
[
"Zorita Serrano",
"Software Engineer",
"San Francisco",
"4389",
"2012/06/01",
"$115,000"
],
[
"Jennifer Acosta",
"Junior Javascript Developer",
"Edinburgh",
"3431",
"2013/02/01",
"$75,650"
],
[
"Cara Stevens",
"Sales Assistant",
"New York",
"3990",
"2011/12/06",
"$145,600"
],
[
"Hermione Butler",
"Regional Director",
"London",
"1016",
"2011/03/21",
"$356,250"
],
[
"Lael Greer",
"Systems Administrator",
"London",
"6733",
"2009/02/27",
"$103,500"
],
[
"Jonas Alexander",
"Developer",
"San Francisco",
"8196",
"2010/07/14",
"$86,500"
],
[
"Shad Decker",
"Regional Director",
"Edinburgh",
"6373",
"2008/11/13",
"$183,000"
],
[
"Michael Bruce",
"Javascript Developer",
"Singapore",
"5384",
"2011/06/27",
"$183,000"
],
[
"Donna Snider",
"Customer Support",
"New York",
"4226",
"2011/01/25",
"$112,000"
]
]
将opal 添加到Gemfile，
gem 'opal-rails'
gem 'opal-jquery'
application.js.rb 内容，
require 'opal'
require 'jquery'
require 'opal-jquery'
require 'datatables.min'
require_tree '.'
将datatables.min.js 文件添加到app/assets/javascripts 文件夹
html,
<table id="organizations-datatable" class="display" style="width:100%">
<thead>
<tr>
<th>Name</th>
<th>Position</th>
<th>Office</th>
<th>Extn.</th>
<th>Start date</th>
<th>Salary</th>
</tr>
</thead>
<tfoot>
<tr>
<th>Name</th>
<th>Position</th>
<th>Office</th>
<th>Extn.</th>
<th>Start date</th>
<th>Salary</th>
</tr>
</tfoot>
</table>
注意：- 如果您希望它与 POST 一起使用，您必须调整您的 config/routes.rb，
在您的 json 文件的 routes.rb 中添加以下条目，
对我来说，
post '/data.json', :to => redirect('/data.json')
对你来说，
post '/organizations/datatable.json', :to => redirect('/organizations/datatable.json')
完整代码在这里 https://gitlab.com/shoyebsheikh/opal-datatables
Ajax 数据表 rails gem 解决方案：
假设这是数据源，您可以将以下行添加到您的路线中，
post '/organizations/datatable.json', :to => redirect('/organizations/datatable.json')
你的控制器应该是这样的，
class OrganizationsController < ApplicationController
def datatable
params["columns"] ||= "0" => "data" => ""
params["length"] ||= -1
respond_to do |format|
format.html
format.json render json: OrganizationDatatable.new(params)
end
end
end
你的数据表如下，
class OrganizationDatatable < AjaxDatatablesRails::ActiveRecord
def view_columns
# Declare strings in this format: ModelName.column_name
# or in aliased_join_table.column_name format
@view_columns ||=
# id: source: "Organization.id" ,
name: source: "Organization.name",cond: :like, searchable: true, orderable: true ,
desc: source: "Organization.description",cond: :like, searchable: true, orderable: true ,
industry: source: "Organization.industry",cond: :like, searchable: true, orderable: true ,
tags: source: "Organization.tag_list", searchable: false, orderable: false
end
def data
records.map do |record|
# id: record.id,
name: record.name,
desc: truncate(record.description,length: 240, separator: ' '),
industry: record.industry,
tags: record.decorate.buttonize_tags,
DT_RowId: record.id
end
end
def get_raw_records
Organization.all
end
end
在您的organizations.js.rb 中输入蛋白石代码，
Document.ready? do
token = Element['meta[name=csrf-token]'].attr('content');
settings =
"ajax":
"url": Element['#organizations-datatable'].data('source'),
"type": 'POST',
"beforeSend": lambda do |xhr|
`xhr.setRequestHeader('X-CSRF-Token', token)`
end
,
"pagingType": "full_numbers",
"destroy": true,
"columns": [
"data": "name",
"data": "desc",
"data": "industry",
"data": "tags"
]
Element['#organizations-datatable'].dataTable(settings.to_n)
end
在 html 中，
<table id="organizations-datatable" data-source="<%= organizations_index_path(format: :json) %>">
<thead>
<tr>
<th>Name</th>
<th>Desc</th>
<th>Industry</th>
<th>tags</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
organizations_index_path 可以是 organizations_path 或单数形式，例如 organization_index_path 或 organization_path，具体取决于您的控制器名称
更多信息请参考https://gitlab.com/shoyebsheikh/ajax-datatables-rails-with-opal。
注意：
-
使用 mysql2 gem。
运行迁移并将条目添加到表中
rails CLI 或手动在表中。
如果您在安装所有依赖项后运行项目并运行迁移，请访问http://localhost:3000/user/index 或http://localhost:3000/hello_world/index
【讨论】：
需要 POST 以避免 414 Request-URI Too Large 错误。 我通过数据表的所有示例都使用 GET，当我在此示例中使用 POST 时，它无法识别 json 文件。 Using POST 来自 this 和 this ...我正在使用 ajax-datatables-rails gem，值得我使用 javascript 与 POST 一起使用的数据表。事实上，OP 中的 javascript sn-p 在 Rails 中运行良好。即使使用对象数组，也可以毫无问题地填充数据表。我实际上是想让 Opal 生成相同的输出。 我现在正在尝试解决这个问题。感谢您的回复。 我仍然坚持这一点。我想奖励你，但它并没有解决问题，这让我很困惑。以上是关于在 Rails 应用程序中转换 Javascript 数据表以使用 Opal的主要内容，如果未能解决你的问题，请参考以下文章
在 Rails 应用程序中转换 Javascript 数据表以使用 Opal