the_sortable_tree 1.0.0 → 1.1.1

data/README.md

@@ -1,8 +1,10 @@
 ### TheSortableTree
 
-GUI for nested_set gem. Rails 3+
+Engine Based GUI for nested_set gem. Rails 3+
 
-**Engine Based**
+**sortable_tree** - recursive helper-method for render sortable nested_set tree.
+
+**sortable_tree** use partials for rendering, that's why it is **so easy to customize**!
 
 ### Install
 
@@ -12,28 +14,44 @@ bundle
 
 ### Require
 
-1. gem 'nested_set'
+1. gem 'nested_set' or gem 'awesome_nested_set'
 2. gem 'haml'
 3. JQuery UI
 
-### Extend you Model
+### Example of using with Page Model
+
+### Extend your Model
+
+``` ruby
+class Page < ActiveRecord::Base
+  # SCOPES FOR SORTABLE NESTED SET
+  include TheSortableTree::Scopes
+  # any code here
+end
+```
+
+### Extend your Controller
 
 ``` ruby
-# SCOPES FOR SORTABLE NESTED SET
-scope :nested_set,          order('lft ASC')
-scope :reversed_nested_set, order('lft DESC')
+class PagesController < ApplicationController
+  include TheSortableTreeController::Rebuild
+  # any code here
+end
 ```
 
-### Extend you Controller
+or (for reversed tree)
 
 ``` ruby
-include TheSortableTreeController::Rebuild
+class PagesController < ApplicationController
+  include TheSortableTreeController::ReversedRebuild
+  # any code here
+end
 ```
 
-### Extend you Routes
+### Extend your Routes
 
 ``` ruby
-resources :elements do
+resources :pages do
   collection do
     get :manage
     post :rebuild
@@ -41,15 +59,40 @@ resources :elements do
 end
 ```
 
-### Find you tree
+**manage** action or any else action for show sortable tree
+
+**rebuild** action is _required_ action for correctly work of **the_sortable_tree**
+
+### Find your tree
 
 ``` ruby
-def manage
-  @elements = Element.all.nested_set
+class PagesController < ApplicationController
+  include TheSortableTreeController::Rebuild
+
+  def manage
+    @pages = Page.nested_set.all
+  end
+
+  # any code here
 end
+
 ```
 
-### Render you tree with TheSortableTree
+or 
+
+``` ruby
+class PagesController < ApplicationController
+  include TheSortableTreeController::ReversedRebuild
+
+  def manage
+    @pages = Page.reversed_nested_set.all
+  end
+  
+  # any code here
+end
+```
+
+### Render your tree with TheSortableTree (Haml markup)
 
 ``` ruby
 - content_for :css do
@@ -57,11 +100,51 @@ end
 - content_for :js do
   = javascript_include_tag 'jquery.ui.nestedSortable'
 
-= sortable_tree @elements, :klass => :element, :rebuild_url => rebuild_elements_path
+= sortable_tree @pages, :klass => :page, :rebuild_url => rebuild_pages_path
 ```
 
 ### Customize
 
 ``` ruby
-rails g the_sortable_tree:views elements
+rails g the_sortable_tree:views pages
+```
+
+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/_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/_new.html.haml
+create  app/views/pages/the_sortable_tree/_tree.html.haml
 ```
+
+**_tree** - root container for nested set elements
+
+**_item** - element of tree (link to current element and childs)
+
+**_link** - decoration of link to current element of tree
+
+**_nested_set** - decoration of childs
+
+**_new** - create new element link
+
+**_controls** - control elements for current tree element
+
+
+**_js_init_sortable_tree** - JS for sortable tree
+
+**_js_on_update_tree**- JS for sortable tree
+
+**_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'
+```

data/app/helpers/the_sortable_tree_helper.rb

@@ -93,7 +93,7 @@ module TheSortableTreeHelper
       # 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]}/nested_set_item",  :locals => {:opts => opts, :node => node, :link => link, :childs => childs_res})
+      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

data/lib/the_sortable_tree/version.rb

@@ -1,3 +1,3 @@
 module TheSortableTree
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/the_sortable_tree.rb

@@ -3,5 +3,13 @@ require "the_sortable_tree/engine"
 require "the_sortable_tree/version"
 
 module TheSortableTree
-  # TheSortableTree
+  # include TheSortableTree::Scopes
+  module Scopes
+    def self.included(base)
+      base.class_eval do
+        scope :nested_set,          order('lft ASC')
+        scope :reversed_nested_set, order('lft DESC')
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_sortable_tree
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000Z
+date: 2012-01-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &84037710 !ruby/object:Gem::Requirement
+  requirement: &74340490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *84037710
+  version_requirements: *74340490
 description: Drug&Drop GUI for nested_set gem. Sortable tree view helper
 email:
 - zykin-ilya@ya.ru
@@ -61,12 +61,12 @@ files:
 - app/controllers/the_sortable_tree_controller.rb
 - app/helpers/the_sortable_tree_helper.rb
 - 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/_nested_set_item.html.haml
 - app/views/the_sortable_tree/_new.html.haml
 - app/views/the_sortable_tree/_tree.html.haml
 - lib/generators/the_sortable_tree/views_generator.rb