jquery_sortable_tree 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a62aa61ef9e134d4b425834fc6f508bc1d30e538
+  data.tar.gz: 0675adaa8d49fb232f0cf77b4f58e6b526b09344
+SHA512:
+  metadata.gz: 044754fe59ffc39b8912576c7192c797e771083bbc212173fad48f5fd2924debb26291b73d5f571847c86d0ed0154929a7f6d03925d95f17a3210c444aa7d5ca
+  data.tar.gz: 42afb0b6db170c62051ab908ace517c751e0dabb670359da81a6818e3a99c5b5be06c2fb775fd7315aba43d86772894be2703e7000136be9af3c515e6e362004

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,319 @@
+# JquerySortableTree
+
+This gem is totally based on [the_sortable_tree](https://github.com/the-teacher/the_sortable_tree) gem.
+
+[![Gem Version](https://badge.fury.io/rb/jquery_sortable_tree.png)](http://badge.fury.io/rb/jquery_sortable_tree) [![Code Climate](https://codeclimate.com/github/maximalink/jquery_sortable_tree.png)](https://codeclimate.com/github/maximalink/jquery_sortable_tree)
+
+> tested with rails 4.1.0rc2 + haml 4
+
+Nested Set + Drag&Drop GUI. Very fast! Best render helper! **2000 nodes/sec**. Ready for rails 4 ([RubyGems](http://rubygems.org/gems/jquery_sortable_tree))
+
+### Dummy Application
+
+* [spec/dummy_app](spec/dummy_app)
+* [spec/dummy_app/README.md](dummy_app/README.md)
+
+## Sortable tree. Drag&Drop GUI
+
+![Drag&Drop GUI. Sotrable tree](docs/sortable.jpg)
+
+## Render tree
+
+![Render tree](docs/tree.jpg)
+
+## Render Nested Options
+
+![Nested options](docs/nested_options.jpg)
+
+## Render Indented Options
+
+![Indented options](docs/indented_options.jpg)
+
+## Expandable tree
+
+![Expandable](docs/expandable.jpg)
+
+## 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)
+
+```ruby
+gem 'awesome_nested_set' # or any similar gem (gem 'nested_set')
+gem 'jquery_sortable_tree', '~> 3.0.0'
+```
+
+Console
+
+```ruby
+bundle
+```
+
+## Using
+
+#### JQuery and JavaScripts
+
+**app/assets/javascripts/application.js**
+
+Sortable GUI require JQuery libs
+
+```ruby
+//= require jquery
+//= require jquery-ui
+//= require jquery_ujs
+```
+
+Add next JS only for Sortable GUI
+
+```ruby
+//= require sortable_tree/initializer
+```
+
+or Extendable GUI:
+
+```ruby
+//= require expandable_tree/initializer
+
+#### Stylesheets
+
+**app/assets/stylesheets/application.css**
+
+```ruby
+*= require tree
+*= require sortable_tree
+*= require expandable_tree
+*= require nested_options
+```
+
+### Extend your Routes for Sortable GUI
+
+```ruby
+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
+
+```ruby
+class Page < ActiveRecord::Base
+  include JquerySortableTree::Scopes
+
+  # any code here
+end
+```
+
+### Extend your controller and find your tree
+
+```ruby
+class PagesController < ApplicationController
+  include JquerySortableTreeController::Rebuild
+
+  def manage
+    @pages = Page.nested_set.select('id, title, content, parent_id').all
+  end
+
+  # any code here
+end
+```
+
+## Basic Render Method
+
+```ruby
+build_server_tree(tree, options)
+```
+
+## Render Tree
+
+**app/views/pages/manage.html.haml**
+
+```haml
+%ol.tree= just_tree @pages
+```
+
+**just_tree** is just alias of **build_server_tree(tree, type: :tree)**
+
+## Render Sortable Tree
+
+```haml
+%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
+
+```haml
+= 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
+
+
+```ruby
+%ol.sortable_tree{ data: { max_levels: 3, rebuild_url: rebuild_pages_url } }
+```
+
+**Server side:**
+
+
+define
+
+```ruby
+build_server_tree(pages, {:option_1 => :value_1, :option_2 => :value_2})
+```
+
+use
+
+```ruby
+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](https://github.com/plataformatec/simple_form)
+is easy:
+
+```ruby
+= 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
+
+```ruby
+bundle exec rails g jquery_sortable_tree:views tree
+bundle exec rails g jquery_sortable_tree:views sortable
+bundle exec rails g jquery_sortable_tree:views nested_options
+bundle exec rails g jquery_sortable_tree:views indented_options
+```
+
+Base Render helper of gem
+
+```ruby
+bundle exec rails g jquery_sortable_tree:views helper
+```
+
+Assets of gem
+
+```ruby
+bundle exec rails g jquery_sortable_tree:views assets
+```
+
+## I want to know more
+
+1. [How to change HTML code of tree?](https://github.com/maximalink/jquery_sortable_tree/blob/master/docs/How_to_change_HTML_code_of_tree.md)
+2. [How to create new tree HTML Builder helper?](https://github.com/maximalink/jquery_sortable_tree/blob/master/docs/How_to_create_new_tree_Render_Helper.md)
+3. [I need to render reversed tree](https://github.com/maximalink/jquery_sortable_tree/blob/master/docs/I_need_to_render_reversed_tree.md)
+4. [Gem can't correctly define a Name of your Model](https://github.com/maximalink/jquery_sortable_tree/blob/master/docs/How_to_correctly_define_a_Name_of_your_Model.md)
+5. [ChangeLog](https://github.com/maximalink/jquery_sortable_tree/blob/master/docs/ChangeLog.md)
+
+## 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
+5. Expand tree via AJAX
+4. Comments Tree gem
+3. gem Ancestry (???)
+
+## I want to try! I need tests!
+
+1. Sorry, but I have not tests for this gem. Gem is so simple. It's easy to test only with test app.
+2. You can write some tests, if you need. I will be happy certainly.
+3. No! I know RSpec. I can write tests. But I have not reasons to write tests here.
+
+##  Аcknowledgment
+
+1. [mjsarfatti/nestedSortable](https://github.com/mjsarfatti/nestedSortable)
+2. [iconza](http://iconza.com)
+
+## 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
+W

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JquerySortableTree'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end
+
+task default: :test

data/app/assets/javascripts/expandable_tree/expandable_tree.js.coffee

@@ -0,0 +1,104 @@
+# ----------------------------------------
+# Restorable Helpers
+# ----------------------------------------
+@add_to_restorable_path = (node) ->
+  if window.is_restorable_tree
+    id = node.data('node-id')
+    nested_tree_path_add(id)
+    return true
+  false
+
+@remove_from_restorable_path = (node) ->
+  if window.is_restorable_tree
+    id = node.data('node-id')
+    nested_tree_path_remove(id)
+    return true
+  false
+
+# ----------------------------------------
+# Main Helpers
+# ----------------------------------------
+@nested_tree_toggle = (button) ->
+  if button.hasClass('minus')
+    button.removeClass('minus').addClass('plus').html('+')
+  else
+    button.removeClass('plus').addClass('minus').html('–')
+
+@append_children_to_node = (node, html) ->
+  html = html.trim()
+  item = node.children('.item')
+
+  button = node.children('.item').children('.expand')
+
+  if html.length is 0
+    button.addClass 'empty'
+
+  if html.length > 0
+    item.after html
+    nested_tree_toggle(button)
+    add_to_restorable_path(node)
+
+@upload_nodes_children = (node, expand_node_url) ->
+  node_id    = node.data('node-id')
+  tree       = $('.sortable_tree')
+  ctrl_items = $('i.handle, b.expand', tree)
+
+  $.ajax
+    type:     'POST'
+    dataType: 'html'
+    data:     { id: node_id }
+    url:      expand_node_url
+
+    beforeSend: (xhr) ->
+      ctrl_items.hide()
+      window.skip_expandable_tree_hashchange = true
+
+    success: (data, status, xhr) ->
+      ctrl_items.show()
+      append_children_to_node(node, data)
+
+    error: (xhr, status, error) ->
+      try
+        console.log error
+
+@init_expandable_tree = ->
+  sortable_tree = $('ol.sortable_tree')
+  return false if sortable_tree.length is 0
+
+  window.is_restorable_tree         ||= false
+  window.is_cookie_restoreable_tree   = sortable_tree.data('cookie_store') || sortable_tree.data('cookie-store')
+
+  if window.is_cookie_restoreable_tree
+    steps = $.cookie(TSTconst.cookie_name())
+    _set_hash(TSTconst.hash_prefix() + steps) if steps
+
+  expand_node_url = sortable_tree.data('expand_node_url') || sortable_tree.data('expand-node-url')
+
+  # Now it's designed only for one tree
+  restore_nested_tree(sortable_tree, expand_node_url) if window.is_restorable_tree
+
+  sortable_tree.on 'click', '.expand.minus', (e) ->
+    button = $ @
+    node   = button.parent().parent()
+    nested_tree_toggle(button)
+    remove_from_restorable_path(node)
+    node.children('.nested_set').hide()
+    false
+
+  sortable_tree.on 'click', '.expand.plus', (e) ->
+    button     = $ @
+    node       = button.parent().parent()
+    nested_set = node.children('.nested_set')
+    
+    if nested_set.length is 0
+      upload_nodes_children(node, expand_node_url)
+    else
+      nested_set.show()
+      nested_tree_toggle(button)
+      add_to_restorable_path(node)
+
+    false
+
+  true
+
+$ -> init_expandable_tree()

data/app/assets/javascripts/expandable_tree/hashchange.js.coffee

@@ -0,0 +1,33 @@
+@_arrays_diff = (a, b) -> b.filter (i) -> return !(a.indexOf(i) > -1)
+
+@expandable_tree_hashchange = (hash_event) ->
+  if window.skip_expandable_tree_hashchange
+    window.skip_expandable_tree_hashchange = false
+    return true
+
+  hash_and_cookie_accordance()
+  
+  oEvent  = hash_event.originalEvent
+  new_url = oEvent.newURL
+  old_url = oEvent.oldURL
+
+  new_hash = new_url.split('#')[1]
+  old_hash = old_url.split('#')[1]
+
+  return false unless ('#'+new_hash).match(TSTconst.re()) or ('#'+old_hash).match(TSTconst.re())
+
+  new_arr = _nested_set_hash_arr(new_hash)
+  old_arr = _nested_set_hash_arr(old_hash)
+  
+  diff_ids = if new_arr.length >= old_arr.length
+    _arrays_diff(old_arr, new_arr)
+  else
+    _arrays_diff(new_arr, old_arr)
+
+  for id in diff_ids
+    btn = $("[data-node-id=#{id}] > .item .expand")
+    btn.click()
+    setTimeout -> window.skip_expandable_tree_hashchange = false
+
+$(window).bind 'hashchange', (hash_event) ->
+  expandable_tree_hashchange(hash_event)

data/app/assets/javascripts/expandable_tree/initializer.js

@@ -0,0 +1,6 @@
+//= require nested_sortable/jquery.ui.nestedSortable
+//= require nested_sortable/inline_operations
+//= require expandable_tree/jquery.cookie
+//= require expandable_tree/restorable
+//= require expandable_tree/hashchange
+//= require expandable_tree/expandable_tree

data/app/assets/javascripts/expandable_tree/jquery.cookie.coffee

@@ -0,0 +1,68 @@
+#!
+# * jQuery Cookie Plugin v1.3.1
+# * https://github.com/carhartl/jquery-cookie
+# *
+# * Copyright 2013 Klaus Hartl
+# * Released under the MIT license
+# 
+((factory) ->
+  if typeof define is "function" and define.amd
+    # AMD. Register as anonymous module.
+    define ["jquery"], factory
+  else
+    # Browser globals.
+    factory jQuery
+) ($) ->
+  pluses = /\+/g
+
+  raw     = (s) -> s
+  decoded = (s) -> decodeURIComponent s.replace(pluses, " ")
+  converted = (s) ->
+    # This is a quoted cookie as according to RFC2068, unescape
+    s = s.slice(1, -1).replace(/\\"/g, "\"").replace(/\\\\/g, "\\")  if s.indexOf("\"") is 0
+    try
+      return (if config.json then JSON.parse(s) else s)
+
+  
+  config = $.cookie = (key, value, options) ->
+    # write
+    if value isnt `undefined`
+      options = $.extend({}, config.defaults, options)
+      
+      if typeof options.expires is "number"
+        days = options.expires
+        t    = options.expires = new Date()
+        t.setDate t.getDate() + days
+      
+      value = (if config.json then JSON.stringify(value) else String(value))
+      
+      # use expires attribute, max-age is not supported by IE
+      return (document.cookie = [(if config.raw then key else encodeURIComponent(key)), "=", (if config.raw then value else encodeURIComponent(value)), (if options.expires then "; expires=" + options.expires.toUTCString() else ""), (if options.path then "; path=" + options.path else ""), (if options.domain then "; domain=" + options.domain else ""), (if options.secure then "; secure" else "")].join(""))
+    
+    # read
+    decode  = (if config.raw then raw else decoded)
+    cookies = document.cookie.split("; ")
+    result  = (if key then `undefined` else {})
+
+    i = 0
+    l = cookies.length
+
+    while i < l
+      parts  = cookies[i].split("=")
+      name   = decode parts.shift()
+      cookie = decode parts.join("=")
+      if key and key is name
+        result = converted(cookie)
+        break
+      result[name] = converted(cookie)  unless key
+      i++
+    result
+
+  config.defaults = {}
+
+  $.removeCookie = (key, options) ->
+    if $.cookie(key) isnt `undefined`
+      # Must not alter options, thus extending a fresh object...
+      $.cookie key, '', $.extend({}, options, expires: -1)
+      return true
+    false