sortable_tree_rails 0.0.1

data/lib/assets/stylesheets/sortable_tree.scss

@@ -0,0 +1,112 @@
+$cOddRowBackground: #f4f5f5;
+$cRowBorder: #e8e8e8;
+$cRowSelected: #d9e4ec;
+$cRowError: rgb(255,87,87);
+
+.ui-sortable > *{
+  cursor: move;
+}
+
+
+.disclose{
+  cursor: pointer;
+  width: 10px;
+  display: none;
+}
+
+
+
+ol.sortable_tree{
+  margin: 16px 0px 16px 0px;
+  padding-left: 0px;
+}
+
+.sortable_tree_wrapper {
+  .left {
+    float: left !important;
+  }
+  .right {
+    float: right !important;
+  }
+
+  ol {
+    list-style-type:none;
+
+    li {
+      cursor: default !important;
+
+      &.placeholder {
+        background: lighten($cOddRowBackground, 10%);
+        border: 1px dashed $cRowSelected;
+        //.box-sizing(border-box);
+        -webkit-box-sizing: border-box;
+        -moz-box-sizing: border-box;
+        box-sizing: border-box;
+
+        &.cantdoit {
+          border: 1px dashed $cRowError;
+        }
+      }
+
+      .item {
+        width: 100%;
+        border-top: 1px solid $cRowBorder;
+        border-bottom: 1px solid $cRowBorder;
+
+        //.clearfix;
+        &::after {
+          content: "";
+          display: table;
+          clear: both;
+        }
+
+        &.even {
+          background: white;
+        }
+
+        &.odd {
+          background: $cOddRowBackground;
+        }
+
+        &:hover {
+          background-color: $cRowSelected;
+          cursor: move;
+        }
+
+        .cell {
+          margin: 0;
+          padding: 10px 12px 8px 12px;
+        }
+
+        h3.cell {
+          font-size: 16px;
+          line-height: 14px;
+          color: black;
+        }
+      }
+    }
+
+    > li > ol {
+      margin-left: 30px;
+    }
+
+    li.mjs-nestedSortable-collapsed > ol {
+      display: none;
+    }
+
+    li.mjs-nestedSortable-branch > div > .disclose {
+      display: block;
+      float: left;
+      padding: 10px 5px 8px 5px;
+    }
+
+    li.mjs-nestedSortable-collapsed > div > .disclose > span:before {
+      content: '+ ';
+    }
+
+    li.mjs-nestedSortable-expanded > div > .disclose > span:before {
+      content: '- ';
+    }
+  }
+}
+

data/lib/sortable_tree_rails/engine.rb

@@ -0,0 +1,7 @@
+module SortableTreeRails
+  class Engine < ::Rails::Engine
+
+
+
+  end
+end

data/lib/sortable_tree_rails/version.rb

@@ -0,0 +1,3 @@
+module SortableTreeRails
+  VERSION = "0.0.1"
+end

data/lib/sortable_tree_rails.rb

@@ -0,0 +1,4 @@
+require "sortable_tree_rails/engine"
+
+module SortableTreeRails
+end

data/lib/tasks/sortable_tree_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sortable_tree_rails do
+#   # Task goes here
+# end

data/readme.md

@@ -0,0 +1,189 @@
+# SortableTreeRails
+
+GUI for sortable tree to manage data organized in tree with ancestry gem.
+
+Works with Rails 4.
+
+
+# Overview
+
+The gem uses:
+* [jquery-sortable plugin](https://johnny.github.io/jquery-sortable/) - jQuery Sortable UI
+* [nestedSortable](https://github.com/ilikenwf/nestedSortable) - a jQuery plugin for nested lists which extends jQuery Sortable UI
+
+# Demo
+See demo app in the repository (spec/dummy).
+Run page with the tree: `http://localhost:3000/categories/manage`.
+
+
+# Usage
+
+
+
+### Gemfile
+
+```
+gem 'ancestry'
+gem 'sortable_tree_rails'
+```
+
+
+### routes
+
+```
+# config/routes.rb
+
+resources :categories do
+  collection do
+     post :sort
+  end
+end
+
+```
+
+This page (sort_categories_path) will be used by the gem to update data after drag&drop.
+
+### model
+
+It assumes that your model has already fields in DB for ancestry.
+
+```
+# app/models/category.rb
+
+class Category < ActiveRecord::Base
+
+  has_ancestry
+
+  # it uses column ancestry_depth
+  # has_ancestry :cache_depth=>true
+
+end
+
+```
+
+
+### Javascript
+
+Include js files in your assets file application.js:
+
+```
+//= require jquery2
+//= require jquery_ujs
+
+//=require jquery-ui/sortable
+//=require jquery.mjs.nestedSortable.js
+
+```
+
+### CSS
+
+Add CSS file to your styles.
+
+for SCSS (app/assets/application.scss):
+
+```
+... your css here ..
+
+@import "sortable_tree";
+
+
+```
+
+
+### controller
+
+```
+class CategoriesController < ApplicationController
+  include SortableTreeController::Sort
+  sortable_tree 'Category', {parent_method: 'parent'}
+
+  def manage
+    # get items to show in tree
+    @items = Category.all.arrange(:order => :pos)
+
+  end
+
+end
+
+```
+
+### view
+
+```
+# app/views/categories/manage.html.haml
+
+= render_sortable_tree(@items, {name_method: :name, sort_url: sort_categories_url, max_levels: 5, controls_partial: 'controls'})
+
+```
+
+
+```
+# app/views/categories/_controls.html.haml
+
+= link_to 'Edit', edit_category_url(item)
+= link_to 'Delete', category_url(item), :method => :delete, :data => { :confirm => 'Are you sure?' }
+
+```
+
+
+
+# Customize
+
+## Options
+
+### Options for controller
+
+in controller:
+```
+
+  include SortableTreeController::Sort
+  sortable_tree 'ClassName', {_options_here_}
+
+```
+
+
+* ClassName - class name (camel case). For example, 'Category'.
+* :sorting_attribute - attribute used for sorting (default: 'pos')
+* :parent_method - method used to access parent for the item (default: 'parent')
+
+
+* If you use ancestry in model - set :parent_method to 'parent':
+
+```
+  include SortableTreeController::Sort
+  sortable_tree 'ClassName', {parent_method: 'parent', sorting_attribute: 'pos'}
+```
+
+* :controls_partial - specify what partial view to use to show control links for each item in a tree. Set to nil to not show controls.
+
+Use local variable `item` in the partial view.
+
+
+## Options for view
+
+```
+= render_sortable_tree(@items, {__options_here})
+```
+
+* name_method - defined which model method (usually, a column name) will be used to show name (default: :name)
+* sort_url - URL used to update data after item is moved to a new position
+* max_levels - max levels to show in tree (default: 5)
+
+
+
+# How it works
+
+read Wiki
+
+
+# Similar gems
+
+GUI for sortable tree with awesome_nested_set gem:
+* https://github.com/the-teacher/the_sortable_tree
+* https://github.com/winescout/the_sortable_tree
+
+
+# Credits
+* Some pieces of code was created by inspiration of gem [ActiveAdmin Sortable Tree](https://github.com/maxivak/activeadmin-sortable-tree/)
+
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: sortable_tree_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Ivak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.5.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GUI for sortable tree to manage data organized in tree with ancestry
+  gem.
+email:
+- maxivak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/controllers/sortable_tree_controller.rb
+- app/helpers/sortable_tree_helper.rb
+- app/views/sortable_tree/_sortable_tree.html.haml
+- config/routes.rb
+- lib/assets/javascripts/jquery.mjs.nestedSortable.js
+- lib/assets/stylesheets/sortable_tree.scss
+- lib/sortable_tree_rails.rb
+- lib/sortable_tree_rails/engine.rb
+- lib/sortable_tree_rails/version.rb
+- lib/tasks/sortable_tree_rails_tasks.rake
+- readme.md
+homepage: https://github.com/maxivak/sortable_tree_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: GUI for sortable tree with ancestry gem
+test_files: []