TheSortableTree

• Originally tested with rails 4.1.0rc2 + haml 4
• Production tested with Rails 5.2.x
• Updated for Rails 6.x compatibility

Nested Set + Drag&Drop GUI. Very fast! Best render helper! 2000 nodes/sec. Ready for rails 4 (RubyGems)

Dummy Application

• spec/dummy_app
• spec/dummy_app/README.md

Sortable tree. Drag&Drop GUI

Render tree

Render Nested Options

Render Indented Options

Expandable tree

Keywords

Awesome nested set, Nested set, Ruby, Rails, Nested set view helper, Sortable nested set, Drag&Drop GUI for nested set, View helper for nested set, render tree

Install

Gemfile (Rails 3, Rails 4)

gem 'awesome_nested_set' # or any similar gem (gem 'nested_set')
#gem 'ancestry'      # alternatively, you can use the ancestry gem
#gem 'acts_as_list'  # plus acts_as_list for sorting
gem "the_sortable_tree", "~> 2.5.0"

Console

bundle

Using

JQuery and JavaScripts

app/assets/javascripts/application.js

Sortable GUI require JQuery libs

//= require jquery
//= require jquery-ui
//= require jquery_ujs

Add next JS only for Sortable GUI

//= require jquery.ui.nestedSortable
//= require sortable_tree/initializer

Stylesheets

app/assets/stylesheets/application.css

*= require tree
*= require sortable_tree
*= require nested_options

Extend your Routes for Sortable GUI

resources :pages do
  collection do
    get :manage

    # required for Sortable GUI server side actions
    post :rebuild
  end
end

manage - just page, where you want render Sortable tree.

Extend your Model

class Page < ActiveRecord::Base
  acts_as_nested_set
  include TheSortableTree::Scopes
  
  # any code here
end

Alternatively you can use ancestry instead of a nested set, optionally combined with acts_as_list for sorting. Please make sure to load these before including TheSortableTree::Scopes.

class Page < ActiveRecord::Base
  has_ancestry
  acts_as_list scope: [:ancestry]
  include TheSortableTree::Scopes
end

Extend your controller and find your tree

class PagesController < ApplicationController
  include TheSortableTreeController::Rebuild

  def manage
    @pages = Page.nested_set.select('id, title, content, parent_id').all
  end

  # any code here
end

Basic Render Method

build_server_tree(tree, options)

Render Tree

app/views/pages/manage.html.haml

%ol.tree= just_tree @pages

just_tree is just alias of build_server_tree(tree, type: :tree)

Render Sortable Tree

%ol.sortable_tree{ data: { max_levels: 5, rebuild_url: rebuild_pages_url } }
  = sortable_tree @pages

sortable_tree is just alias of build_server_tree(tree, type: :sortable)

Render Nested Options Tree

= select_tag :page_id, nested_options(@pages, :selected => Page.last), class: :nested_options

nested_options is just alias of build_server_tree(tree, type: :nested_options)

This uses CSS styling, for indenting with spaces, use indented_options instead.

build_server_tree options

Client side:

Required params for sortable GUI! Must be defined at root element of tree.

1. max_levels - maximum depth of nesting
2. rebuild_url - URL to rebuild method on server side

%ol.sortable_tree{ data: { max_levels: 3, rebuild_url: rebuild_pages_url } }

Server side:

define

build_server_tree(pages, {:option_1 => :value_1, :option_2 => :value_2})

use

options[:NAME]

Options list:

1. id - id field of node
2. title - title field of node
3. type - type of tree [tree|sortable|nested_options|indented_options]
4. namespace - for example: :admin. [] - by default
5. render_module - your own Render Tree Helper
6. spacing - number of spaces per level (indented_options only)

Rendering runtime params (see code of render helpers):

You can use next options, when rendering run:

1. level - level number
2. root - root flag [true|false]
3. klass - class name
4. has_children - has children flag [true|false]
5. children - array of children

Simple_form input

Using indented options with simple_form is easy:

= simple_form_for @website do |form|
  = form.association :front_page, as: :indented_collection_select

Additional options can be supplied to the input:

1. spacing - number of spaces to use for each level (default 3)
2. depth_method - method name to get level from object (default :depth)

Please note that when you're using awesome_nested_set, you need to have the optional depth column in your table.

Customization

Try to run next view generators:

Render helpers for HTML tree generation

bundle exec rails g the_sortable_tree:views tree
bundle exec rails g the_sortable_tree:views sortable
bundle exec rails g the_sortable_tree:views nested_options
bundle exec rails g the_sortable_tree:views indented_options

Base Render helper of gem

bundle exec rails g the_sortable_tree:views helper

Assets of gem

bundle exec rails g the_sortable_tree:views assets

I want to know more

1. How to change HTML code of tree?
2. How to create new tree HTML Builder helper?
3. I need to render reversed tree
4. Gem can't correctly define a Name of your Model
5. ChangeLog

Is it fast? Yes, it is!

BANCHMARK:

tree params: 16.000 nodes, 3 levels

• Views: 7999.6ms | ActiveRecord: 79.2ms
• WebInspector full time ~ 9.64s

total: ~ 2000 nodes/sec

Looking for maintainers

Do you want to be open source contributor? There are some ideas:

Try to create view helpers for:

1. Mongoid NestedSet
2. acts_as_ordered_tree
3. Expand tree via AJAX
4. Comments Tree gem
5. gem Ancestry (???)

I want to try! I need tests!

1. I'm develop gem with test app the_sortable_tree_test_app. You can clone it and see some testcase-pages for gem
2. Sorry, but I have not tests for this gem. Gem is so simple. It's easy to test only with test app.
3. You can write some tests, if your need. I will be happy certainly.
4. No! I know RSpec. I can write tests. But I have not reasons to write tests here.

Аcknowledgment

1. mjsarfatti/nestedSortable
2. iconza

The MIT License (MIT)

Copyright 2009-2013 Ilya N. Zykin (the-teacher), Mikhail Dieterle (Mik-die), Matthew Clark

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.