the_sortable_tree 1.2.0 → 1.4.6

data/README.md

@@ -1,5 +1,7 @@
 ### TheSortableTree
 
+**Dev status: GEM is FINISHED! **
+
 Engine Based GUI for awesome_nested_set gem. Rails 3+
 
 ![TheSortableTree](https://github.com/the-teacher/the_sortable_tree/raw/master/pic.jpg)
@@ -8,6 +10,14 @@ Engine Based GUI for awesome_nested_set gem. Rails 3+
 
 **sortable_tree** uses partials for rendering, that's why it is **so easy to customize**!
 
+### Is it fast?
+
+Hmmmm...
+Development env, 584 elements, 3 levels deep - rendered by 50 sec.
+I think it is good result.
+
+Do you can makes it fester? Welcome!
+
 ### Install
 
     gem 'the_sortable_tree'
@@ -26,7 +36,6 @@ bundle
 
 ``` ruby
 class Page < ActiveRecord::Base
-  # SCOPES FOR SORTABLE NESTED SET
   include TheSortableTree::Scopes
   # any code here
 end
@@ -102,10 +111,45 @@ end
 - content_for :js do
   = javascript_include_tag 'jquery.ui.nestedSortable'
 
-= sortable_tree @pages, :klass => :page, :rebuild_url => rebuild_pages_path
+= sortable_tree @pages, :new_url => new_page_path, :max_levels => 4
+```
+
+or (without administrator controls and drag&drop)
+
+``` ruby
+- content_for :css do
+  = stylesheet_link_tag 'the_sortable_tree_min', :media => :screen
+
+= sortable_tree @pages, :new_url => new_page_path, :path => 'the_sortable_tree_min'
+```
+
+### Customize tree for User (min version)
+
+**Use sortable_tree as view helper for simple rendering of nested_set tree**
+
+``` ruby
+rails g the_sortable_tree:views pages min
+```
+
+It's will generate minimal set of view partials for **sortable_tree** helper
+
+``` ruby
+create  app/views/pages/the_sortable_tree_min
+create  app/views/pages/the_sortable_tree_min/_children.html.haml
+create  app/views/pages/the_sortable_tree_min/_node.html.haml
+create  app/views/pages/the_sortable_tree_min/_link.html.haml
+create  app/views/pages/the_sortable_tree_min/_tree.html.haml
+```
+
+Just use it or Customize and use it!
+
+``` ruby
+- content_for :css do
+  = stylesheet_link_tag 'the_sortable_tree_min', :media => :screen
+= sortable_tree @pages, :new_url => new_page_path, :path => 'pages/the_sortable_tree_min'
 ```
 
-### Customize
+### Customize tree for Administrator (full version)
 
 ``` ruby
 rails g the_sortable_tree:views pages
@@ -116,27 +160,40 @@ It's will generate view partials for **sortable_tree** helper
 ``` ruby
 create  app/views/pages/the_sortable_tree
 create  app/views/pages/the_sortable_tree/_controls.html.haml
-create  app/views/pages/the_sortable_tree/_item.html.haml
+create  app/views/pages/the_sortable_tree/_node.html.haml
 create  app/views/pages/the_sortable_tree/_js_init_sortable_tree.html.haml
 create  app/views/pages/the_sortable_tree/_js_on_update_tree.html.haml
 create  app/views/pages/the_sortable_tree/_js_rebuild_ajax.html.haml
 create  app/views/pages/the_sortable_tree/_link.html.haml
-create  app/views/pages/the_sortable_tree/_nested_set.html.haml
+create  app/views/pages/the_sortable_tree/_children.html.haml
 create  app/views/pages/the_sortable_tree/_new.html.haml
 create  app/views/pages/the_sortable_tree/_tree.html.haml
 ```
 
+Customize and use it!
+
+``` ruby
+- content_for :css do
+  = stylesheet_link_tag 'the_sortable_tree', :media => :screen
+- content_for :js do
+  = javascript_include_tag 'jquery.ui.nestedSortable'
+
+= sortable_tree @pages, :new_url => new_page_path, :path => 'pages/the_sortable_tree', :max_levels => 2
+```
+
+### Partials
+
 **_tree** - root container for nested set elements
 
-**_item** - element of tree (link to current element and childs)
+**_node** - element of tree (link to current node and nested set of children)
 
 **_link** - decoration of link to current element of tree
 
-**_nested_set** - decoration of childs
+**_children** - decoration of children
 
 **_new** - create new element link
 
-**_controls** - control elements for current tree element
+**_controls** - control elements for current node
 
 
 **_js_init_sortable_tree** - JS for sortable tree
@@ -145,12 +202,6 @@ create  app/views/pages/the_sortable_tree/_tree.html.haml
 
 **_js_rebuild_ajax**- JS for sortable tree
 
-Customize and use it!
-
-``` ruby
-= sortable_tree @pages, :klass => :page, :rebuild_url => rebuild_pages_path, :path => 'pages/the_sortable_tree'
-```
-
 ### Acknowledgments
 
 * https://github.com/mjsarfatti/nestedSortable

data/app/assets/stylesheets/the_sortable_tree.css

@@ -54,14 +54,14 @@
   margin:0 0 0 3px;
   cursor:pointer;
 }
-.root_create_image{
+.nested_set_new_image{
   vertical-align:middle;
   border:none;
 }
-.root_create_link{
+.nested_set_new{
   margin:25px 0;
 }
-.root_create_link a{
+.nested_set_new a{
   font-size:14pt;
 }
 .nested_set .handle{

data/app/assets/stylesheets/the_sortable_tree_min.css

@@ -0,0 +1,16 @@
+ol.nested_set_min li{
+    font-size: 1.4em;
+    line-height: 130%;
+    margin-bottom: 5px;
+    font-weight: bold;
+}
+ol.nested_set_min ol{
+    border-left: 1px dashed #AAA;
+    padding-left: 10px;
+    margin-left: 15px;
+    margin-top: 5px;
+}
+ol.nested_set_min ol li{ font-weight: normal; }
+
+.nested_set_min a:hover { color: #003A89 !important; }
+.nested_set_min a:visited { color: #809dc4; }

data/app/helpers/the_sortable_tree_helper.rb

@@ -1,107 +1,56 @@
 module TheSortableTreeHelper
   # Publicated by MIT
   # Nested Set View Helper
-  # Ilya Zykin, zykin-ilya@ya.ru, Russia, Ivanovo 2009-2011
+  # Ilya Zykin, zykin-ilya@ya.ru, Russia, Ivanovo 2009-2012
   # github.com/the-teacher
   #-------------------------------------------------------------------------------------------------------
-  
-  # = sortable_tree(@pages)
-  # = sortable_tree @products, :klass => :product, :path => 'products/the_sortable_tree', :rebuild_url => rebuild_products_path
 
-  def create_root_element_link(options= {})
-    opts= {:top_root => false}.merge!(options)
-    render :partial  =>  "#{opts[:path]}/new", :locals  =>  { :opts  =>  opts }
-  end
+  # = sortable_tree @pages, :new_url => new_page_url, :max_levels => 5
+  # = sortable_tree @products, :new_url => new_product_url, :path => 'products/the_sortable_tree'
 
-  def ans_controls(node, options= {})
-    opts= {
-      :id_field => 'id',    # id field name, id by default
-      :first => false,      # first element flag
-      :last => false,       # last element flag
-      :has_childs => false  # has childs?
-    }.merge!(options)
-    render :partial  =>  "#{opts[:path]}/controls", :locals  =>  { :node => node, :opts  =>  opts }
+  def define_class_of_elements_of tree
+    return nil if tree.empty?
+    tree.first.class.to_s.downcase
   end
 
-  def sortable_tree(tree, options= {})
-    path = 'the_sortable_tree'
-    path = options[:path] if options[:path] && File.directory?([Rails.root, :app, :views, options[:path]].join '/')
-    klass = options[:klass].to_s
-    tree = sortable_tree_bilder(tree, options.merge!({:path => path, :klass => klass}))
-    render :partial => "#{path}/tree", :locals => { :tree => tree, :opts => options }
+  def sortable_tree(tree, opts= {})
+    opts.merge!({
+      :path  => opts[:path] || :the_sortable_tree,
+      :klass => define_class_of_elements_of(tree),
+      :title => opts[:title] || :title,
+      :max_levels => opts[:max_levels] || 3
+    })
+    render :partial => "#{opts[:path]}/tree", :locals => { :tree => sortable_tree_builder(tree, opts), :opts => opts }
   end
 
-  def sortable_tree_bilder(tree, options= {})
-    result= ''
-    opts= {
+  def sortable_tree_builder(tree, options= {})
+    result = ''
+    opts = {
+      :id => :id,           # node id field
       :node => nil,         # node
-      :admin => true,       # render admin tree?
-      :root => false,       # is it root node? 
-      :id_field => 'id',    # id field name, id by default
-      :first => false,      # first element flag
-      :last => false,       # last element flag
-      :level =>  0,         # recursion level
-      :clean => true        # delete element from tree after rendering. ~25% time economy when rendering tree once on a page
+      :root => false,       # is it root node?
+      :level => 0           # recursion level
     }.merge!(options)
 
-    node = opts[:node]
     root = opts[:root]
-
-    # must be string
-    opts[:id_field] = opts[:id_field].to_s
+    node = opts[:node]
 
     unless node
-      roots= tree.select{|elem| elem.parent_id.nil?}
-      # find ids of first and last root node
-      roots_first_id= roots.empty? ? nil : roots.first.id
-      roots_last_id=  roots.empty? ? nil : roots.last.id
-      
-      # render roots
+      roots = tree.select{|elem| elem.parent_id.nil?}      
       roots.each do |root|
-        is_first= (root.id==roots_first_id)
-        is_last= (root.id==roots_last_id)
-        _opts = opts.merge({:node => root, :root => true, :level => opts[:level].next, :first => is_first, :last => is_last})
-        result<< sortable_tree_bilder(tree, _opts)
+        _opts = opts.merge({:node => root, :root => true, :level => opts[:level].next})
+        result << sortable_tree_builder(tree, _opts)
       end
     else
-      res= ''
-      controls= ''
-      childs_res= ''
-
-      # select childs
-      childs= tree.select{|elem| elem.parent_id == node.id}
-      opts.merge!({:has_childs => childs.blank?})
-
-      # admin controls
-      if opts[:admin]
-        c = ans_controls(node, opts)
-        controls= content_tag(:span, c, :class => :controls)
+      children_res = ''
+      children = tree.select{|elem| elem.parent_id == node.id}
+      opts.merge!({:has_children => children.blank?})
+      children.each do |elem|
+        _opts = opts.merge({:node => elem, :root => false, :level => opts[:level].next})
+        children_res << sortable_tree_builder(tree, _opts)
       end
-
-      # find id of first and last node
-      childs_first_id= childs.empty? ? nil : childs.first.id
-      childs_last_id=  childs.empty? ? nil : childs.last.id
-
-      # render childs
-      childs.each do |elem|
-        is_first= (elem.id==childs_first_id)
-        is_last= (elem.id==childs_last_id)
-        _opts = opts.merge({:node => elem, :root => false, :level => opts[:level].next, :first => is_first, :last => is_last})
-        childs_res << sortable_tree_bilder(tree, _opts)
-      end
-
-      # build views
-      childs_res= childs_res.blank? ? '' : render(:partial => "#{opts[:path]}/nested_set", :locals => {:opts => opts, :parent => node, :childs => childs_res})
-      link= render(:partial => "#{opts[:path]}/link", :locals => {:opts => opts, :node => node, :root => root, :controls => controls})
-      res= render(:partial => "#{opts[:path]}/item",  :locals => {:opts => opts, :node => node, :link => link, :childs => childs_res})
-
-      # delete current node from tree if you want
-      # recursively moving by tree is 25%+ faster on 500 elems
-      # remove from Array, not from DB! ;) ?! Array#pull?!
-      # tree.delete(node) if opts[:clean]
-
-      result << res
+      result << render(:partial => "#{opts[:path]}/node", :locals => {:opts => opts, :root => root, :node => node, :children => children_res})
     end
     raw result
-  end#sortable_tree_bilder
-end# module
+  end# sortable_tree_builder
+end# module

data/app/views/the_sortable_tree/_children.html.haml

@@ -0,0 +1 @@
+= content_tag :ol, raw(children)

data/app/views/the_sortable_tree/_controls.html.haml

@@ -1,16 +1,16 @@
 -# EDIT
-- edit= link_to "", polymorphic_url(node, :action => :edit), :title => t("#{opts[:klass].pluralize}.edit_this"), :class => "button edit"
+- edit = link_to '', polymorphic_url(node, :action => :edit), :title => t('.edit_this'), :class => 'button edit'
 -# DELETE
-- if opts[:has_childs]
-  - delete= link_to("", url_for(node),
-    :title    =>  t("#{opts[:klass].pluralize}.delete"),
+- if opts[:has_children]
+  - delete =  link_to('', url_for(node),
+    :title    =>  t('.delete'),
     :method   =>  :delete,
-    :confirm  =>  t("#{opts[:klass].pluralize}.delete_confirm"),
-    :class    =>  "button delete")
+    :confirm  =>  t('.delete_confirm'),
+    :class    =>  'button delete')
 - else
-  - delete=  link_to("", "#",
-    :title    =>  t("#{opts[:klass].pluralize}.cant_be_deleted"),
-    :onclick  =>  t("#{opts[:klass].pluralize}.delete_nested_elements"),
-    :class    =>  "button undeleted")
+  - delete =  link_to('', '#',
+    :title    =>  t('.cant_be_deleted'),
+    :onclick  =>  "alert('#{t('.delete_nested_elements')}')",
+    :class    =>  'button undeleted')
 -# OUTPUT
 = edit + delete

data/app/views/the_sortable_tree/_js_init_sortable_tree.html.haml

@@ -1,12 +1,12 @@
 :javascript
-  $(document).ready(function(){
+  $(function(){
     $('ol.sortable').nestedSortable({
       disableNesting: 'no-nest',
       forcePlaceholderSize: true,
-      handle: 'div.handle',
+      handle: 'i.handle',
       helper: 'clone',
       items: 'li',
-      maxLevels: 3,
+      maxLevels: #{opts[:max_levels]},
       opacity: .6,
       placeholder: 'placeholder',
       revert: 250,

data/app/views/the_sortable_tree/_js_on_update_tree.html.haml

@@ -1,5 +1,5 @@
 :javascript
-  $(document).ready(function(){
+  $(function(){
     $('ol.sortable').sortable({
       update: function(event, ui){
         parent_id = ui.item.parent().parent().attr('id');

data/app/views/the_sortable_tree/_js_rebuild_ajax.html.haml

@@ -1,21 +1,13 @@
 :javascript
   function sortable_tree(item_id, parent_id, prev_id, next_id){
     jQuery.ajax({
-      type: 'POST',
-      url: '#{opts[:rebuild_url]}',
-      data: { id: item_id,
-              parent_id: parent_id,
-              prev_id: prev_id,
-              next_id: next_id },
-      dataType: 'script',
-      beforeSend: function(xhr){
-        //$('##{opts[:klass]}_nested_set .handle').hide();
-      },
-      success: function(data, status, xhr){
-        //$('##{opts[:klass]}_nested_set .handle').show();
-      },
-      error: function(xhr, status, error){
-        alert(error);
-      }
+      type:       'POST',
+      dataType:   'script',
+      url:        '#{url_for(:controller => opts[:klass].pluralize, :action => :rebuild)}',
+      data:       { id: item_id, parent_id: parent_id, prev_id: prev_id, next_id: next_id },
+
+      beforeSend: function(xhr){ $('.nested_set i.handle').hide() },
+      success:    function(data, status, xhr){ $('.nested_set i.handle').show() },
+      error:      function(xhr, status, error){ alert(error) }
     });
   }

data/app/views/the_sortable_tree/_link.html.haml

@@ -1,10 +1,7 @@
-- if opts[:admin]
-  - handle=   content_tag :div, raw(" "), :class => :handle
-  - link=     link_to(node.title, url_for(node), :title => node.title)
-  - content=  raw(handle.to_s) + controls + link
-  %div{ :class => "link#{' root' if root}" }
-    = content
-- else
-  %div{:class => "link #{"root" if root}"}
-    = link_to(node.title, polymorphic_path(node), :title => node.title)
-
+- title     = node.send opts[:title]
+- handle    = content_tag :i, '', :class => :handle
+- link      = link_to(title, url_for(node), :title => title)
+- controls  = render(:partial  =>  "#{opts[:path]}/controls", :locals  =>  { :node => node, :opts => opts })
+- controls  = content_tag(:b, controls, :class => :controls)
+- element   = handle + controls + link
+%div{ :class => "link#{' root' if root}" }= element

data/app/views/the_sortable_tree/_new.html.haml

@@ -1,3 +1,3 @@
-- image=  image_tag('iconza/blue/add.png', :class => :root_create_image) + raw(' ')
-- link=   link_to(image + raw(t("#{opts[:klass].pluralize}.new.create")), url_for(:controller => opts[:klass].pluralize, :action => :new))
-.root_create_link= link
+- image = image_tag('iconza/blue/add.png', :class => :nested_set_new_image) + ' '
+- link  = link_to(image + t('.create'), opts[:new_url])
+.nested_set_new= link

data/app/views/the_sortable_tree/_node.html.haml

@@ -0,0 +1,3 @@
+%li{ :id => "#{node.send(opts[:id])}_#{opts[:klass]}" }
+  = raw render(:partial => "#{opts[:path]}/link", :locals => {:opts => opts, :root => root, :node => node})
+  = render(:partial => "#{opts[:path]}/children", :locals => {:opts => opts, :parent => node, :children => children}) unless children.blank?

data/app/views/the_sortable_tree/_tree.html.haml

@@ -1,6 +1,6 @@
-= render :partial => "#{opts[:path]}/js_init_sortable_tree"
-= render :partial => "#{opts[:path]}/js_on_update_tree"
-= render :partial => "#{opts[:path]}/js_rebuild_ajax", :locals => { :opts => opts }
-%ol.sortable.ui-sortable.nested_set{ :id => "#{opts[:klass]}_nested_set" }
-  = raw tree
-= render :partial => "#{opts[:path]}/new", :locals => { :opts => opts }
+= render :partial => "#{opts[:path]}/new", :locals => { :opts => opts }
+- unless tree.empty?
+  = render :partial => "#{opts[:path]}/js_init_sortable_tree", :locals => { :opts => opts }
+  = render :partial => "#{opts[:path]}/js_on_update_tree"
+  = render :partial => "#{opts[:path]}/js_rebuild_ajax", :locals => { :opts => opts }
+  %ol.ui-sortable.sortable.nested_set{ :id => "#{opts[:klass]}_nested_set" }= raw tree

data/app/views/the_sortable_tree_min/_children.html.haml

@@ -0,0 +1 @@
+= content_tag :ol, raw(children)

data/app/views/the_sortable_tree_min/_link.html.haml

@@ -0,0 +1 @@
+= link_to node.send(opts[:title]), url_for(node), :title => node.send(opts[:title])

data/app/views/the_sortable_tree_min/_node.html.haml

@@ -0,0 +1,3 @@
+%li
+  = raw render(:partial => "#{opts[:path]}/link", :locals => {:opts => opts, :root => root, :node => node})
+  = render(:partial => "#{opts[:path]}/children", :locals => {:opts => opts, :parent => node, :children => children}) unless children.blank?

data/app/views/the_sortable_tree_min/_tree.html.haml

@@ -0,0 +1,2 @@
+- unless tree.empty?
+  %ol.nested_set_min= raw tree

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  the_sortable_tree:
+    new:
+      create: Add element
+    controls:
+      edit_this: Edit element
+      delete: Delete element
+      delete_confirm: Do you want to delete element? 
+      cant_be_deleted: Cant be deleted. Has nested elements
+      delete_nested_elements: Delete all nested elements

data/config/locales/ru.yml

@@ -0,0 +1,10 @@
+ru:
+  the_sortable_tree:
+    new:
+      create: Добавить элемент
+    controls:
+      edit_this: Редактировать элемент
+      delete: Удалить элемент
+      delete_confirm: Удалить элемент безвозвратно?
+      cant_be_deleted: Не может быть удалено. Есть дочерние элементы
+      delete_nested_elements: Сперва удалите все дочерние элементы

data/lib/generators/the_sortable_tree/views_generator.rb

@@ -5,15 +5,19 @@ module TheSortableTree
 
       def self.banner
         <<-BANNER.chomp
-rails g the_sortable_tree:views MODEL
+rails g the_sortable_tree:views MODEL [min]
   Copies files for rendering sortable nested set
         BANNER
       end
 
       def copy_sortable_tree_files
-        directory "the_sortable_tree", "app/views/#{folder}/the_sortable_tree"
+        if ARGV[1] == 'min'
+          directory "the_sortable_tree_min", "app/views/#{folder}/the_sortable_tree_min"
+        else
+          directory "the_sortable_tree", "app/views/#{folder}/the_sortable_tree"
+        end
       end
-        
+
       private
 
       def folder

data/lib/the_sortable_tree/version.rb

@@ -1,3 +1,3 @@
 module TheSortableTree
-  VERSION = "1.2.0"
+  VERSION = "1.4.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_sortable_tree
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-07 00:00:00.000000000Z
+date: 2012-01-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &68015970 !ruby/object:Gem::Requirement
+  requirement: &84551760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *68015970
+  version_requirements: *84551760
 description: Drug&Drop GUI for awesome_nested_set gem. Sortable tree view helper
 email:
 - zykin-ilya@ya.ru
@@ -58,17 +58,24 @@ files:
 - app/assets/images/iconza/red/zoom.png
 - app/assets/javascripts/jquery.ui.nestedSortable.js
 - app/assets/stylesheets/the_sortable_tree.css
+- app/assets/stylesheets/the_sortable_tree_min.css
 - app/controllers/the_sortable_tree_controller.rb
 - app/helpers/the_sortable_tree_helper.rb
+- app/views/the_sortable_tree/_children.html.haml
 - app/views/the_sortable_tree/_controls.html.haml
-- app/views/the_sortable_tree/_item.html.haml
 - app/views/the_sortable_tree/_js_init_sortable_tree.html.haml
 - app/views/the_sortable_tree/_js_on_update_tree.html.haml
 - app/views/the_sortable_tree/_js_rebuild_ajax.html.haml
 - app/views/the_sortable_tree/_link.html.haml
-- app/views/the_sortable_tree/_nested_set.html.haml
 - app/views/the_sortable_tree/_new.html.haml
+- app/views/the_sortable_tree/_node.html.haml
 - app/views/the_sortable_tree/_tree.html.haml
+- app/views/the_sortable_tree_min/_children.html.haml
+- app/views/the_sortable_tree_min/_link.html.haml
+- app/views/the_sortable_tree_min/_node.html.haml
+- app/views/the_sortable_tree_min/_tree.html.haml
+- config/locales/en.yml
+- config/locales/ru.yml
 - lib/generators/the_sortable_tree/views_generator.rb
 - lib/the_sortable_tree.rb
 - lib/the_sortable_tree/engine.rb

data/app/views/the_sortable_tree/_item.html.haml

@@ -1,3 +0,0 @@
-%li{ :id => "#{node.id}_#{opts[:klass]}" }
-  = raw link
-  = childs

data/app/views/the_sortable_tree/_nested_set.html.haml

@@ -1 +0,0 @@
-= content_tag(:ol, raw(childs), :id=>"#{parent.id}_page_childs")