mongoid_sortable_tree 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d0d0b62424845c6976a125c591e60dc87865327
+  data.tar.gz: 6eac520710d71a3b356e068bb712ad8d1796d6a2
+SHA512:
+  metadata.gz: b4a422a2285d2d69ea76edbb8fc2b03b96014e1424235442bf966474f6df3b49bb51b6e1624833eee1ddd3fd9f0c1d9fda543ee5189d810c93355447b26f0b47
+  data.tar.gz: dded03a1b34e41273b2bb303c230c18b13e4a8a66a5cc4e6cd17696c6f287180b354cca4b85ff2178f1d822a001bb383569053c6d6e2dffe6b53844f0e8d2bf2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Chun-Yu, Chen (Aloha Chen)
+
+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,162 @@
+#MongoidSortableTree
+
+Mongoid_sortable_tree helps you build views for Mongoid-tree using jstree.
+
+This gem is inspired by [the_sortable_tree](https://github.com/the-teacher/the_sortable_tree). 
+
+> This is my first gem, if there are any problems, please do not hesitate to contact me.
+
+## Table of contents
+
+- [Setup](#setup)
+- [What's Done](#demo)
+- [Usage](#how-to-use)
+- [TODO](#todo)
+- [Аcknowledgment](#acknowledgment)
+- [License](#license)
+
+
+## Setup
+
+To install, add this line to your `Gemfile` and run `bundle install`:
+
+```ruby
+gem 'mongoid_sortable_tree'
+```
+
+Please make sure that you have:
+
+```ruby
+gem "mongoid-tree"
+gem "jstree-rails-4"
+```
+
+## Demo
+
+![Drag and Drop GUI](https://dl.dropboxusercontent.com/u/22307926/Blog%20Image/mongoid_sortable_tree/Mongoid_Srotable_Tree_example.png)
+
+## How to Use
+
+### Add these lines to your `app/assets/javascripts/application.js`
+
+```ruby
+//= require jquery
+//= require jquery_ujs
+//= require jstree
+//= require mongoid_sortable_tree
+``` 
+
+### Add these lines to your `app/assets/stylesheets/application.css`
+
+ref: [jstree-rails-4](https://github.com/kesha-antonov/jstree-rails-4)
+
+```ruby
+*= require jstree-default
+
+# or 
+
+*= require jstree-default-dark
+```
+
+### In Model 
+
+Assume that you have a model `app/models/tag.rb`
+
+```ruby
+class Tag
+  include Mongoid::Document
+  include MongoidSortableTree::Tree
+end
+```
+
+after include `MongoidSortableTree::Tree`, you now support these fields and mongoid-tree's methods.
+
+```ruby
+include Mongoid::Tree
+include Mongoid::Tree::Ordering
+include Mongoid::Tree::Traversal
+field :text, :type => String
+field :icon, :type => String
+field :li_attr, :type => String
+field :a_attr, :type => String
+```
+
+### In Controller
+
+Assume that you will use controller `app/controllers/tags_controller.rb`
+
+```ruby
+class TagsController < ApplicationController
+  include MongoidSortableTreeController::CRUD
+  def index
+    @tags = Tag.all
+  end
+end
+```
+
+### In View
+
+Assume that you will show tree GUI in `index.html.slim`
+
+```ruby
+#mongoid-sorable-js-tree
+  = build_server_tree @tags
+```
+
+### In Route
+
+Add these lines to `config/routes.rb`
+
+```ruby
+resources :tags do 
+  collection do 
+    get 'check'
+  end
+end
+```
+
+### Finally, initialize your view for jstree using helper
+
+Assume that you have `app/assets/javascripts/tags.js`
+
+```ruby
+$(document).on('ready page:load', function() {
+  jstree_helper.init('#mongoid-sorable-js-tree');
+});
+```
+
+## Todo 
+
+- Support [Json Data](https://www.jstree.com/docs/json) View
+- More customization supports 
+- Travis CI、codeclimate ...etc
+
+
+## Acknowledgment
+
+1. [the-teacher/the_sortable_tree](https://github.com/the-teacher/the_sortable_tree)
+2. [jsTree](https://www.jstree.com/)
+3. [benedikt/mongoid-tree](https://github.com/benedikt/mongoid-tree)
+
+## License
+
+Copyright 2015 Chun-Yu, Chen (Aloha Chen)
+
+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/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MongoidSortableTree'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/mongoid_sortable_tree.coffee

@@ -0,0 +1,73 @@
+jQuery ->
+  jstree_helper = window.jstree_helper
+  if !jstree_helper
+    jstree_helper = window.jstree_helper =
+      default_setting: 
+        update_url: '/tags'
+        create_url: '/tags'
+        show_url: '/tags'
+        destroy_url: '/tags'
+        index_url: '/tags'
+        check_url: '/tags/check'
+
+      mregeSettings: (optsArr) ->
+        setting = @default_setting
+        optsArr = if typeof optsArr != 'undefined' then [optsArr] else []
+        idx = 0
+        len = optsArr.length
+        curr = undefined
+        key = undefined
+        while idx < len
+          curr = optsArr[idx]
+          for key of curr
+            k = key
+            setting[k] = curr[k]
+          idx++
+        setting
+
+      create: (parent_id,text) -> 
+        $.ajax
+          url: @default_setting.create_url
+          data: { "text": data, "parent_id": parent_id}
+          type: 'POST'
+
+      init: (target,args) ->
+        settings = @mregeSettings(args)
+        $(target).jstree
+          'core':
+            'animation': 0
+            'check_callback': (operation,node,node_parent,info) -> 
+              if this.get_buffer().mode == 'copy_node'
+                operation = 'copy_node'
+              $.when(
+                $.ajax
+                  url: settings.check_url
+                  data: { "operation": operation, "node": node, "node_parent": node_parent, "info": info}
+                  type: 'GET'
+                  target: target
+                  node: node
+                  node_parent: node_parent
+              ).then((data, textStatus, jqXHR) -> 
+                if textStatus == 'success'
+                  if data.operation == 'create_node'
+                    new_node_id = $('#'+this.node_parent.id).find("input[value='"+this.node.text+"']").closest('li').attr('id')
+                    $.jstree.reference(this.target).set_id(new_node_id,data.id)
+                  if data.operation == 'copy_node'
+                    location.reload()
+                    # new_node_id = $('#'+this.node_parent.id).find("a:contains('"+ this.node.text+"')").closest('li').attr('id')
+                    # $.jstree.reference(this.target).set_id(new_node_id,data.id)
+                  true
+              ).fail ->
+                $.jstree.reference(this.target).refresh()
+                false
+            'themes': 'stripes': true
+          'dnd':
+            'check_while_dragging': false 
+          'plugins': [
+            'contextmenu'
+            'dnd'
+            'search'
+            'state'
+            'wholerow'
+            'changed'
+          ]

data/app/controllers/mongoid_sortable_tree_controller.rb

@@ -0,0 +1,97 @@
+module MongoidSortableTreeController
+  # include MongoidSortableTreeController::CRUD
+  
+  module DefineVariablesMethod
+    public
+    def the_define_common_variables
+      collection = self.class.to_s.split(':').last.sub(/Controller/,'').underscore.downcase                 # 'recipes'
+      collection = self.respond_to?(:sortable_collection) ? self.sortable_collection : collection           # 'recipes'
+      variable   = collection.singularize                                                                   # 'recipe'
+      klass      = self.respond_to?(:sortable_model) ? self.sortable_model : variable.classify.constantize  #  Recipe
+      ["@#{variable}", collection, klass]
+    end
+  end
+  
+  module CRUD
+    include DefineVariablesMethod
+    def check
+      operation   = params[:operation]
+      node        = params[:node]
+      node_parent = params[:node_parent] 
+      info        = params[:info]
+      return render(nothing: true, status: 406) unless operation && node && node_parent
+      
+      variable, collection, klass = self.the_define_common_variables
+      # variable  = self.instance_variable_set(variable, klass.find(id))
+      
+      validation = self.send(operation.to_sym, node, node_parent, info)
+
+      return render json: {id: validation[:id], operation: operation, message: validation[:msg] }, status: validation[:status]
+    end
+    def create_node(node,node_parent,info)
+      variable, collection, klass = self.the_define_common_variables
+      variable  = self.instance_variable_set(variable, klass.new(text: node[:text]))
+      variable.parent = klass.where(:id => node_parent[:id]).first
+      if variable.valid?
+        variable.save
+        return {id: variable.id.to_s, msg: 'created', status: 200}
+      else
+        return {id: variable.id.to_s, msg: variable.errors.full_messages, status: 406}
+      end
+    end
+
+    def rename_node(node,node_parent,info)
+      variable, collection, klass = self.the_define_common_variables
+      variable  = self.instance_variable_set(variable, klass.where(:id => node[:id]).first)
+      if variable && variable.update_attributes(:text => info)
+        return {id: variable.id.to_s, msg: 'updated', status: 200}
+      else
+        return {id: variable.try(:id).to_s, msg: variable.try(:errors).try(:full_messages), status: 406}
+      end
+    end
+
+    def delete_node(node,node_parent,info)
+      variable, collection, klass = self.the_define_common_variables
+      variable  = self.instance_variable_set(variable, klass.where(:id => node[:id]).first)
+      if variable && variable.destroy
+        return {id: variable.id.to_s, msg: 'deleted', status: 200}
+      else
+        return {id: variable.id.to_s, msg: variable.errors.full_messages, status: 406}
+      end
+    end
+
+    def move_node(node,node_parent,info)
+      variable, collection, klass = self.the_define_common_variables
+      variable  = self.instance_variable_set(variable, klass.where(:id => node[:id]).first)
+      parent = klass.where(:id => node_parent[:id]).first
+      if variable && variable.update_attribute(:parent_id,parent.try(:id))
+        return {id: variable.id.to_s, msg: 'moved', status: 200}
+      else
+        return {id: variable.id.to_s, msg: variable.errors.full_messages, status: 406}
+      end
+    end
+
+    def copy_node(node,node_parent,info)
+      begin
+        variable, collection, klass = self.the_define_common_variables
+        variable  = self.instance_variable_set(variable, klass.where(:id => node[:id]).first)
+        parent = klass.where(:id => node_parent[:id]).first
+        id_mapping = {}
+        variable.traverse(:breadth_first).each_with_index do |node,index|
+          copied_item = node.clone
+          id_mapping[node.id] = copied_item.id
+          if index == 0
+            copied_item.update_attribute(:parent_id,parent.try(:id))
+          elsif id_mapping[copied_item.parent_id]
+            copied_item.update_attribute(:parent_id,id_mapping[copied_item.parent_id])
+          end
+        end
+        return {id: id_mapping.keys.map(&:to_s), msg: 'cpoied', status: 200}
+      rescue => e 
+        return {id: variable.id.to_s, msg: 'Failed to copy', status: 406}
+      end
+    end
+
+  end
+
+end

data/app/helpers/mongoid_sortable_tree_helper.rb

@@ -0,0 +1,96 @@
+module MongoidSortableTreeHelper
+  # Default renderers
+  TREE_RENDERERS = {
+    :sortable => RenderSortableTreeHelper
+  }
+
+
+  ###############################################
+  # Common Base Methods
+  ###############################################
+  def define_class_of_elements_of node
+    case
+      when node.is_a?(Array) then node.first.class.to_s.underscore.downcase
+      when node.nil?       then 'tag'
+      else node.class.to_s.underscore.downcase
+    end
+  end
+
+  def build_tree_html tree, render_module, options = {}
+    render_module::Render::render_node(tree, options)
+  end
+
+  def build_server_tree(tree, options: {})
+    result = ''
+    tree   = Array.wrap tree
+    opts   = {
+      # base options
+      :type  => :sortable,    # tree type
+      :id    => :id,          # id field
+      :node  => nil,          # node
+      :title => :text,        # title field
+      :li_attr => :li_attr,
+      :a_attr => :a_attr,
+      :root  => false,    # is it root node?
+      :level => 0,        # recursion level
+      :boost => {} 
+    }.merge!(options)
+
+     # Basic vars
+    root = opts[:root]
+    node = opts[:node]
+
+    # namespace prepare [Rails require]
+    opts[:namespace] = Array.wrap opts[:namespace]
+
+    # Module with **Render** class
+    opts[:render_module] = TREE_RENDERERS[opts[:type]] unless opts[:render_module]
+    
+    opts[:klass] = define_class_of_elements_of(tree) unless opts[:klass]
+
+    if opts[:boost].empty?
+      tree.each do |item|
+        num = item.parent_id || 0
+        opts[:boost][num.to_s] = [] unless opts[:boost][num.to_s]
+        opts[:boost][num.to_s].push item
+      end
+    end
+
+    unless node
+      # RENDER ROOTS
+      roots = opts[:boost]['0']
+
+      # define roots, if it's need
+      if roots.nil? && !tree.empty?
+        min_parent_ids = tree.map(&:parent_ids).min { |x,y| x.size <=> y.size }
+        roots = tree.select{ |elem| elem.parent_ids == min_parent_ids }
+      end
+
+      # children rendering
+      if roots
+        roots.each do |root|
+          _opts  =  opts.merge({ :node => root, :root => true, :level => opts[:level].next, :boost => opts[:boost] })
+          result << build_server_tree(tree, options: _opts)
+        end
+      end
+    else
+      # RENDER NODE'S CHILDREN
+      children_res = ''
+      # has parent_id which mean it has children
+      children = opts[:boost][node.id.to_s]
+
+      opts.merge!({ :has_children => children.blank? })
+
+      unless children.nil?
+        children.each do |elem|
+          _opts        =  opts.merge({ :node => elem, :root => false, :level => opts[:level].next, :boost => opts[:boost] })
+          children_res << build_server_tree(tree, options: _opts)
+        end
+      end
+
+      result << build_tree_html(self, opts[:render_module], opts.merge({ :root => root, :node => node, :children => children_res }))
+    end
+    raw result
+  end
+
+end

data/app/helpers/render_sortable_tree_helper.rb

@@ -0,0 +1,36 @@
+module RenderSortableTreeHelper
+  module Render 
+    class << self
+      attr_accessor :helper, :options
+
+      def render_node(helper, options)
+        @helper, @options = helper, options
+        node = options[:node]
+        id_field = options[:id]
+        li_attr_field = options[:li_attr]
+        "
+          <ul>
+            <li id='#{ node.send(id_field) }' #{node.send(li_attr_field)} >
+              #{ show_link }
+              #{ children }
+            </li>
+          </ul>
+        "
+      end
+
+      def show_link
+        node = options[:node]
+        title_field = options[:title]
+        a_attr_field = options[:a_attr]
+        "<a #{node.send(a_attr_field)}>#{node.send(title_field)}</a>"
+      end
+
+      def children
+        unless options[:children].blank?
+          options[:children]
+        end
+      end
+
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/mongoid_sortable_tree/engine.rb

@@ -0,0 +1,7 @@
+module MongoidSortableTree
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.fixture_replacement :factory_girl, dir: "test/test/factories"
+    end
+  end
+end

data/lib/mongoid_sortable_tree/version.rb

@@ -0,0 +1,3 @@
+module MongoidSortableTree
+  VERSION = "0.0.2"
+end

data/lib/mongoid_sortable_tree.rb

@@ -0,0 +1,57 @@
+require "mongoid_sortable_tree/engine"
+
+module MongoidSortableTree
+  module Tree
+    extend ActiveSupport::Concern
+    included do
+      include Mongoid::Tree
+      include Mongoid::Tree::Ordering
+      include Mongoid::Tree::Traversal
+      field :text, :type => String
+      field :icon, :type => String
+      field :li_attr, :type => String
+      field :a_attr, :type => String
+      index :text => 1
+    end
+
+    ##
+    # This module implements class methods that will be available
+    # on the document that includes MongoidSortableTree::Tree
+    module ClassMethods
+      def build_materialized_path(tailored_hierarchy_data: [], from_root: false, category_hierarchy: nil, klass: nil)
+        target = from_root ? (klass.nil? ? self.roots : klass.classify.constantize.roots) : category_hierarchy.children
+        target.each do |data|
+          custom_display_data = {
+            :id       => data.id.to_s,
+            :text     => data.text,
+            :icon     => data.icon,
+            :li_attr  => data.li_attr,
+            :a_attr   => data.a_attr,
+            :klass    => klass,
+            :children => build_materialized_path(category_hierarchy: data, klass: klass)
+          }
+          tailored_hierarchy_data << custom_display_data
+        end
+        tailored_hierarchy_data
+      end
+
+      def build_tree_from_root(options={})
+         build_materialized_path(from_root: true, klass: options[:klass])
+      end
+
+      def build_tree_from_node(node,options={})
+        return_array = []
+        custom_display_data = {
+          :id       => node.id.to_s,
+          :text     => node.text,
+          :icon     => node.icon,
+          :li_attr  => node.li_attr,
+          :a_attr   => node.a_attr,
+          :klass    => options[:klass],
+          :children => build_materialized_path(category_hierarchy: node, klass: options[:klass])
+        }
+        return_array << custom_display_data
+      end
+    end
+  end
+end

data/lib/tasks/mongoid_sortable_tree_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require jstree
+//= require mongoid_sortable_tree
+//= require_tree .

data/test/dummy/app/assets/javascripts/tags.js

@@ -0,0 +1,5 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+$(document).on('ready page:load', function() {
+  return jstree_helper.init('#mongoid-sorable-js-tree');
+});