MongoDB support

[marshallmassengill]

Would love to see Mongoid support added. How can I help?

[antillas21]

Hi @marshallmassengill

I would love to finally have Mongoid support for this gem :)

If you want to help drive out this feature, please take a look at this gem's v-0-4-0 branch here: https://github.com/antillas21/ajax-datatables-rails/tree/v-0-4-0

This branch represents a rewrite on some methods and code organization for the gem. The idea behind this effort is to provide a better API to developers, and become the 1.0.0 version of the gem.

You will notice here in the AjaxDatatablesRails::Base that most methods are hook methods that have to be implemented by an ORM specific module, like the default AjaxDatatablesRails::ORM::ActiveRecord module.

So, if you'd like to help, you can:

• take a look at the code
• add an AjaxDatatablesRails::ORM::Mongoid module inside the lib/ajax-datatables-rails/orm/ directory
• implement the corresponding hook methods inside the module
• add the corresponding tests (this is very important)
• open a PR
• get credited by the feature in the CHANGELOG when the merge is completed

[marshallmassengill]

I'll start tinkering and let you know how far I get with it. I've got a
project driving this so I have some motivation.

Thanks!

---Marshall

On Thursday, July 9, 2015, Antonio Antillon notifications@github.com
wrote:

Hi @marshallmassengill https://github.com/marshallmassengill

I would love to finally have Mongoid support for this gem :)

If you want to help drive out this feature, please take a look at this
gem's v-0-4-0 branch here:
https://github.com/antillas21/ajax-datatables-rails/tree/v-0-4-0

This branch represents a rewrite on some methods and code organization for
the gem. The idea behind this effort is to provide a better API to
developers, and become the 1.0.0 version of the gem.

You will notice here in the AjaxDatatablesRails::Base
https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails/base.rb#L64-L78
that most methods are hook methods that have to be implemented by an ORM
specific module, like the default AjaxDatatablesRails::ORM::ActiveRecord
https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails/orm/active_record.rb
module.

So, if you'd like to help, you can:

• take a look at the code
• add an AjaxDatatablesRails::ORM::Mongoid module inside the
  lib/ajax-datatables-rails/orm/ directory
• implement the corresponding hook methods inside the module
• add the corresponding tests (this is very important)
• open a PR
• get credited by the feature in the CHANGELOG when the merge is
  completed

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

---Marshall

[antillas21]

Excellent! Let me know if you get stuck anywhere, perhaps I may help.

Really looking forward to what you build :)

[marshallmassengill]

I need some help with understanding what is going on with the calls to
Arel. I'm not familiar with Arel. I've been reading about it and the
nearest I can figure is that you are creating a new table from the search
results. Is that correct?

What's going on with the join in the sort_column method?

---Marshall

On Thu, Jul 9, 2015 at 2:38 PM, Antonio Antillon notifications@github.com
wrote:

Excellent! Let me know if you get stuck anywhere, perhaps I may help.

Really looking forward to what you build :)

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

[antillas21]

Hey @marshallmassengill ,

Inside the AjaxDatatablesRails::ORM::ActiveRecord module, we use Arel to build a search query targeting all and each of the columns defined inside the view_columns method (regular jQuery.dataTables approach) or a search query targeting a specific column (through the use of an additional jQuery plugin or hand-made approach following dataTables documentation).

You can see an example of the SQL query produced in these specs, you will notice we cast columns to TEXT, VARCHAR, or CHAR depending on the db engine used.

Now, as you will be implementing support for Mongoid, I'm not sure you will interact with Arel at all, I'd like to think you won't need to.

Perhaps the following is oversimplistic, but somehow I think this would be your starting point for implementing Mongoid support.

Hope all this helps to wrap your mind around the library. Let me know if I can help you with anything else.

[marshallmassengill]

That's actually pretty much what I have right now, albeit a bit more filled
in. I removed a bunch of methods since it doesn't seem like I need them
with Mongo handling the search the way it does.

I ran into an error related to javascript and trying to load the
AjaxDatatablesRails::ORM::Mongoid module though. How does that get
loaded? Is it just the config file that I need to worry about?

Thanks!

---Marshall

On Fri, Jul 10, 2015 at 12:20 PM, Antonio Antillon <notifications@github.com

wrote:

Hey @marshallmassengill https://github.com/marshallmassengill ,

Inside the AjaxDatatablesRails::ORM::ActiveRecord module, we use Arel to
build a search query targeting all and each of the columns defined inside
the view_columns method (regular jQuery.dataTables approach) or a search
query targeting a specific column (through the use of an additional jQuery
plugin or hand-made approach following dataTables documentation).

You can see an example of the SQL query produced in these specs
https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/spec/ajax-datatables-rails/orm/active_record_filter_records_spec.rb#L144,
you will notice we cast columns to TEXT, VARCHAR, or CHAR
https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/spec/ajax-datatables-rails/orm/active_record_filter_records_spec.rb#L189-L217
depending on the db engine used.

Now, as you will be implementing support for Mongoid, I'm not sure you
will interact with Arel at all, I'd like to think you won't need to.

Perhaps the following is oversimplistic, but somehow I think this would be
your starting point
https://gist.github.com/antillas21/1e155f2b3f3ccd3d50a6 for
implementing Mongoid support.

Hope all this helps to wrap your mind around the library. Let me know if I
can help you with anything else.

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

[antillas21]

Ok, make sure you:

• add the new mongoid module to the list of module requires here: https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails.rb
• add the corresponding extend clause here: https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails/base.rb#L99-L100

And that should be all that is needed to wire the new ORM module into the gem.

[marshallmassengill]

So I was making progress and I've hit a wall with something that seems to
be more related to ajax or javascript than anything else. I'm not sure how
to troubleshoot it to be honest.

When loading my site, I'm getting this error: SyntaxError: [stdin]:8:9:
unexpected :

<%= stylesheet_link_tag    "application" %>
<%= javascript_include_tag "vendor/modernizr" %>
<%= javascript_include_tag "application", 'data-turbolinks-track' => true %>
<%= csrf_meta_tags %>

It seems to be coming from the application.js file but I have no idea what
would be causing the issue. Any ideas or suggestions?

Thanks!

---Marshall

On Fri, Jul 10, 2015 at 1:00 PM, Antonio Antillon notifications@github.com
wrote:

Ok, make sure you:

• add the new mongoid module to the list of module requires here:
  https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails.rb
• add the corresponding extend clause here:
  https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails/base.rb#L99-L100

And that should be all that is needed to wire the new ORM module into the
gem.

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

[antillas21]

@marshallmassengill well... to be honest, as a rule of thumb, I always suggest to turn off turbolinks and only leave it on if you know what you're doing.

My recommendation would be:

<head>
  <%= stylesheet_link_tag    "application" %>
  <%= javascript_include_tag "vendor/modernizr" %>
  <%= javascript_include_tag "application" %>
  <%= csrf_meta_tags %>
</head>

[marshallmassengill]

Yeah, I actually went down that road initially thinking it was turbolinks
but it doesn't seem to be. It's kind of a red herring since it is just a
parameter for loading the application.js file, which is where the issue is
originating.

Even without the turbolinks reference, I still get the same error. Some
other interesting things are happening in the .coffee file:

$ ->
$('#virtualMachinesTable').dataTable
processing: true
serverSide: true
ajax: $('#virtualMachinesTable').data('source')
pagingType: 'full_numbers'

That doesn't work, kicking out the same 500 error but this does at least
load the page (albeit with no entries):

$ ->
$('#virtualMachinesTable').dataTable
processing: true
serverSide: true
#ajax: $('#virtualMachinesTable').data('source')
pagingType: 'full_numbers'

So the issue seems to be coming from that line but I'm honestly not sure
why and tracing it back further has been a struggle so far.

---Marshall

On Mon, Jul 13, 2015 at 1:34 PM, Antonio Antillon notifications@github.com
wrote:

@marshallmassengill https://github.com/marshallmassengill well... to be
honest, as a rule of thumb, I always suggest to turn off turbolinks and
only leave it on if you know what you're doing.

My recommendation would be:

<%= stylesheet_link_tag "application" %> <%= javascript_include_tag "vendor/modernizr" %> <%= javascript_include_tag "application" %> <%= csrf_meta_tags %>

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

[antillas21]

If that's a coffee file, remember that indentation matters... I would also check that #virtualMachinesTable table would have a data-source attribute and that is pointing to the JSON version of the route that will instantiate the datatables class, otherwise this can be causing the trouble.

I may be available to help you debug this if you can/want to set a screenshare session (Google Hangout, preferably).

[marshallmassengill]

Ok... this is going to take me a little longer than I thought. I need a
new keyboard since I just took mine out back and shot it for its treasonous
tabbing behavior.

Thanks for the help.

I typed this via very quick pulsing of the USB lines to make the
characters. #codesohard

---Marshall

On Mon, Jul 13, 2015 at 1:53 PM, Antonio Antillon notifications@github.com
wrote:

If that's a coffee file, remember that indentation matters... I would
also check that #virtualMachinesTable table would have a data-source
attribute and that is pointing to the JSON version of the route that will
instantiate the datatables class, otherwise this can be causing the trouble.

I may be available to help you debug this if you can/want to set a
screenshare session (Google Hangout, preferably).

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

[antillas21]

LOL! No worries, as I said before, I am interested in finally adding support for mongoid (several people have already asked about it), so if I can help in any way to ease the process, don't hesitate in scheduling a hangout/screenshare to debug.

[marshallmassengill]

Alright,

I got past that and now I'm stuck on this one:

AjaxDatatablesRails::NotImplemented in VirtualmachinesController#index

    You should implement this method in your class and return an array
    of database columns based on the columns displayed in the HTML view.
    These columns should be represented in the ModelName.column_name,
    or aliased_join_table.column_name notation.

It seems like this should be pretty straightforward. Do I need to add an
include to the controller?

---Marshall

On Mon, Jul 13, 2015 at 2:05 PM, Antonio Antillon notifications@github.com
wrote:

LOL! No worries, as I said before, I am interested in finally adding
support for mongoid (several people have already asked about it), so if I
can help in any way to ease the process, don't hesitate in scheduling a
hangout/screenshare to debug.

—
Reply to this email directly or view it on GitHub
#110 (comment)
.

[antillas21]

No, the error should be fixed once you add a view_columns method in your datatable class as it's coming from here: https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails/base.rb#L123-L131 and called here: https://github.com/antillas21/ajax-datatables-rails/blob/v-0-4-0/lib/ajax-datatables-rails/base.rb#L20-L22

So, your datatable class should define a view_columns method, say:

class MyMongoidDatatable < AjaxDatatablesRails::Base
  def view_columns
    @view_columns ||= [
      # this is the array of columns the error mentions
    ]
  end
end