rails_admin_nestable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Andrea Dal Ponte
+
+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,100 @@
+# Rails Admin Nestable
+
+Reorganise model data with a drag and drop tree/list structure.
+
+
+## Installation
+
+To enable rails_admin_nestable, add the following to your `Gemfile`:
+
+```ruby
+gem "rails_admin_nestable", git: "git://github.com/dalpo/rails_admin_nestable.git"
+```
+
+Add in your `config/initializers/rails_admin.rb` initializer the configuration:
+```ruby
+RailsAdmin.config do |config|
+  config.actions do
+    # root actions
+    dashboard                     # mandatory
+    # collection actions
+    index                         # mandatory
+    new
+    export
+    history_index
+    bulk_delete
+    # member actions
+    show
+    edit
+    delete
+    history_show
+    show_in_app
+
+    # Add the nestable action for each model
+    nestable do
+      visible do
+        [NavNode, Product].include? bindings[:abstract_model].model
+      end
+    end
+  end
+end
+```
+
+## Configuration
+You could choose between two different configurations for your model:
+
+### 1. Nestable tree:
+To use this configuration, you need to organize your tree model with [Ancestry](https://github.com/stefankroes/ancestry).
+Otherwise your model have to respond to the `parent`, `arrange` and `children` methods.
+
+The `nestable_tree` methods supports the following options:
+  * `position_field`: (symbol) default `nil`
+  * `max_depth`: (integer) default `nil`
+
+In your `config/initializers/rails_admin.rb` initializer:
+```ruby
+RailsAdmin.config do |config|
+  config.actions do
+    ...
+  end
+
+  config.model MyModel do
+    nestable_tree({ position_field: :position, max_depth: 3 })
+  end
+end
+```
+
+
+### 2. Nestable list:
+To use this configuration, you need a position field
+
+The `nestable_list` methods supports the following options:
+  * `position_field`: (symbol) default `:position`
+
+In your `config/initializers/rails_admin.rb` initializer:
+```ruby
+RailsAdmin.config do |config|
+  config.actions do
+    ...
+  end
+
+  config.model MyModel do
+    nestable_list true
+  end
+end
+```
+
+## Screenshot
+
+![Nestable view](https://github.com/dalpo/rails_admin_nestable/raw/master/screenshots/nestable_tree.jpg "nestable view")
+
+## Thanks
+
+* [Carlo Scortegagna](https://github.com/carloscortegagna)
+* [Andrea Zaupa](https://github.com/andreazaupa)
+* [Rails Admin](https://github.com/sferik/rails_admin)
+* [Nestable](http://dbushell.github.com/Nestable)
+
+
+
+**This project rocks and uses MIT-LICENSE.**

data/Rakefile

@@ -0,0 +1,27 @@
+#!/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    = 'RailsAdminNestable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/rails_admin/rails_admin_nestable.js.coffee

@@ -0,0 +1,34 @@
+//= require jquery.nestable.js
+//= require_self
+
+$(document).ready ->
+  $tree_nodes = $('#tree_nodes')
+  $tree_nodes_options = {}
+  $tree_nodes_max_depth = $tree_nodes.data('max-depth')
+
+  if $tree_nodes_max_depth && $tree_nodes_max_depth != 'false'
+    $tree_nodes_options['maxDepth'] = $tree_nodes_max_depth
+
+  $tree_nodes
+    .nestable( $tree_nodes_options )
+    .on
+      change: (event) ->
+        serialized_tree = $tree_nodes.nestable('serialize')
+
+        $.ajax
+          url: $tree_nodes.data('update-path'),
+          type: 'POST',
+          data:
+            tree_nodes: serialized_tree
+          success: (data) ->
+            $flash = $('<div>')
+              .addClass('nestable-flash alert')
+              .append( $('<button>').addClass('close').data('dismiss', 'alert').html('&times;') )
+              .append( $('<span>').addClass('body').html( data ) )
+
+            $('#rails_admin_nestable')
+              .append( $flash )
+
+            $flash.fadeIn(200)
+              .delay(2000).fadeOut 200, ->
+                $(this).remove()

data/app/assets/stylesheets/rails_admin/rails_admin_nestable.css

@@ -0,0 +1,158 @@
+/**
+ * Nestable
+ */
+
+.dd {
+    position: relative;
+    display: block;
+    margin: 0;
+    padding: 0;
+    /* max-width: 600px; */
+    list-style: none;
+    font-size: 13px;
+    line-height: 20px; }
+
+.dd-list {
+    display: block;
+    position: relative;
+    margin: 0;
+    padding: 0;
+    list-style: none;
+}
+.dd-list .dd-list { padding-left: 30px; }
+.dd-collapsed .dd-list { display: none; }
+
+.dd-item,
+.dd-empty,
+.dd-placeholder { display: block; position: relative; margin: 0; padding: 0; min-height: 20px; font-size: 13px; line-height: 20px; }
+
+.dd-handle {
+    display: block; height: 30px; margin: 5px 0; padding: 5px 10px; color: #333; text-decoration: none; font-weight: bold; border: 1px solid #ccc;
+    background: #fafafa;
+    background: -webkit-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:    -moz-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:         linear-gradient(top, #fafafa 0%, #eee 100%);
+    -webkit-border-radius: 3px;
+            border-radius: 3px;
+    box-sizing: border-box; -moz-box-sizing: border-box;
+}
+.dd-handle:hover { color: #2ea8e5; background: #fff; }
+
+.dd-item > button { display: block; position: relative; cursor: pointer; float: left; width: 25px; height: 20px; margin: 5px 0; padding: 0; text-indent: 100%; white-space: nowrap; overflow: hidden; border: 0; background: transparent; font-size: 12px; line-height: 1; text-align: center; font-weight: bold; }
+.dd-item > button:before { content: '+'; display: block; position: absolute; width: 100%; text-align: center; text-indent: 0; }
+.dd-item > button[data-action="collapse"]:before { content: '-'; }
+
+.dd-placeholder,
+.dd-empty { margin: 5px 0; padding: 0; min-height: 30px; background: #f2fbff; border: 1px dashed #b6bcbf; box-sizing: border-box; -moz-box-sizing: border-box; }
+.dd-empty { border: 1px dashed #bbb; min-height: 100px; background-color: #e5e5e5;
+    background-image: -webkit-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff),
+                      -webkit-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff);
+    background-image:    -moz-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff),
+                         -moz-linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff);
+    background-image:         linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff),
+                              linear-gradient(45deg, #fff 25%, transparent 25%, transparent 75%, #fff 75%, #fff);
+    background-size: 60px 60px;
+    background-position: 0 0, 30px 30px;
+}
+
+.dd-dragel { position: absolute; pointer-events: none; z-index: 9999; }
+.dd-dragel > .dd-item .dd-handle { margin-top: 0; }
+.dd-dragel .dd-handle {
+    -webkit-box-shadow: 2px 4px 6px 0 rgba(0,0,0,.1);
+            box-shadow: 2px 4px 6px 0 rgba(0,0,0,.1);
+}
+
+/**
+ * Nestable Extras
+ */
+
+.nestable-lists { display: block; clear: both; padding: 30px 0; width: 100%; border: 0; border-top: 2px solid #ddd; border-bottom: 2px solid #ddd; }
+
+#nestable-menu { padding: 0; margin: 20px 0; }
+
+#nestable-output,
+#nestable2-output { width: 100%; height: 7em; font-size: 0.75em; line-height: 1.333333em; font-family: Consolas, monospace; padding: 5px; box-sizing: border-box; -moz-box-sizing: border-box; }
+
+#nestable2 .dd-handle {
+    color: #fff;
+    border: 1px solid #999;
+    background: #bbb;
+    background: -webkit-linear-gradient(top, #bbb 0%, #999 100%);
+    background:    -moz-linear-gradient(top, #bbb 0%, #999 100%);
+    background:         linear-gradient(top, #bbb 0%, #999 100%);
+}
+#nestable2 .dd-handle:hover { background: #bbb; }
+#nestable2 .dd-item > button:before { color: #fff; }
+
+@media only screen and (min-width: 700px) {
+
+    .dd { float: none; width: auto; }
+    .dd + .dd { margin-left: 2%; }
+
+}
+
+.dd-hover > .dd-handle { background: #2ea8e5 !important; }
+
+/**
+ * Nestable Draggable Handles
+ */
+
+.dd3-content { display: block; height: 30px; margin: 5px 0; padding: 5px 10px 5px 40px; color: #333; text-decoration: none; font-weight: bold; border: 1px solid #ccc;
+    background: #fafafa;
+    background: -webkit-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:    -moz-linear-gradient(top, #fafafa 0%, #eee 100%);
+    background:         linear-gradient(top, #fafafa 0%, #eee 100%);
+    -webkit-border-radius: 3px;
+            border-radius: 3px;
+    box-sizing: border-box; -moz-box-sizing: border-box;
+}
+.dd3-content:hover { color: #2ea8e5; background: #fff; }
+
+.dd-dragel > .dd3-item > .dd3-content { margin: 0; }
+
+.dd3-item > button { margin-left: 30px; }
+
+.dd3-handle { position: absolute; margin: 0; left: 0; top: 0; cursor: pointer; width: 30px; text-indent: 100%; white-space: nowrap; overflow: hidden;
+    border: 1px solid #aaa;
+    background: #ddd;
+    background: -webkit-linear-gradient(top, #ddd 0%, #bbb 100%);
+    background:    -moz-linear-gradient(top, #ddd 0%, #bbb 100%);
+    background:         linear-gradient(top, #ddd 0%, #bbb 100%);
+    border-top-right-radius: 0;
+    border-bottom-right-radius: 0;
+}
+.dd3-handle:before { content: '≡'; display: block; position: absolute; left: 0; top: 3px; width: 100%; text-align: center; text-indent: 0; color: #fff; font-size: 20px; font-weight: normal; }
+.dd3-handle:hover { background: #ddd; }
+
+.dd3-content .links {
+    width: auto;
+}
+.dd3-content ul.inline.actions {
+    margin: 0;
+    padding: 0;
+    list-style: none;
+    display: block
+}
+.dd3-content ul.inline.actions li {
+    display: inline;
+}
+.dd3-content ul.inline.actions li a {
+    width: 14px;
+    height: 16px;
+    text-decoration: none;
+}
+.dd3-content ul.inline.actions li a:hover {
+    text-decoration: none;
+}
+
+#rails_admin_nestable {
+    position: relative;
+}
+.nestable-flash {
+    position: fixed;
+    top: 80px;
+    width: auto;
+    right: 20px;
+    display: none;
+    min-width: 150px;
+}

data/app/helpers/rails_admin/nestable_helper.rb

@@ -0,0 +1,5 @@
+module RailsAdmin
+  module NestableHelper
+
+  end
+end

data/app/views/rails_admin/main/nestable.html.haml

@@ -0,0 +1,40 @@
+:ruby
+  def nested_tree_nodes(tree_nodes = [])
+    tree_nodes.map do |tree_node, sub_tree_nodes|
+      li_classes = 'dd-item dd3-item'
+
+      content_tag :li, class: li_classes, :'data-id' => tree_node.id do
+
+        output = content_tag :div, 'drag', class: 'dd-handle dd3-handle'
+        output+= content_tag :div, class: 'dd3-content' do
+          content = link_to @model_config.with(object: tree_node).object_label, edit_path(@abstract_model, tree_node.id)
+          content+= content_tag :div, action_links(tree_node), class: 'pull-right links'
+        end
+
+        if sub_tree_nodes && sub_tree_nodes.any?
+          output+= content_tag :ol, nested_tree_nodes(sub_tree_nodes), class: 'dd-list'
+        end
+
+        output
+      end
+    end.join.html_safe
+  end
+
+  def action_links(model)
+    content_tag :ul, class: 'inline actions' do
+      menu_for :member, @abstract_model, model, true
+    end
+  end
+
+  def tree_max_depth
+    @nestable_conf.options[:max_depth] || 'false'
+  end
+
+.row-fluid
+  .span12#rails_admin_nestable
+    #tree_nodes.dd{:'data-update-path' => nestable_path(model_name: @abstract_model), :'data-max-depth' => tree_max_depth}
+      %ol.dd-list
+        = nested_tree_nodes @tree_nodes
+
+= stylesheet_link_tag 'rails_admin/rails_admin_nestable'
+= javascript_include_tag 'rails_admin/rails_admin_nestable'

data/config/locales/nestable.en.yml

@@ -0,0 +1,12 @@
+en:
+  admin:
+    actions:
+      nestable:
+        title: "Sorting"
+        menu: "Sorting for %{model_label}"
+        breadcrumb: "Sorting"
+        link: "Sorting"
+        bulk_link: "Sort selected %{model_label_plural}"
+        done: "Sorted"
+        success: "Success"
+        error: "Error"

data/config/locales/nestable.it.yml

@@ -0,0 +1,12 @@
+it:
+  admin:
+    actions:
+      nestable:
+        title: "Ordinamento"
+        menu: "Ordinamento %{model_label}"
+        breadcrumb: "Ordinamento"
+        link: "Ordinamento"
+        bulk_link: "Ordinamento %{model_label_plural}"
+        done: "Salvato"
+        success: "Salvato"
+        error: "Errore"

data/lib/rails_admin_nestable.rb

@@ -0,0 +1,13 @@
+require 'rails_admin_nestable/engine'
+
+module RailsAdminNestable
+end
+
+require 'rails_admin/config/actions'
+require 'rails_admin/config/model'
+
+require 'rails_admin_nestable/configuration'
+require 'rails_admin_nestable/nestable'
+require 'rails_admin_nestable/model'
+# require 'rails_admin_nestable/helper'
+

data/lib/rails_admin_nestable/configuration.rb

@@ -0,0 +1,37 @@
+module RailsAdminNestable
+  class Configuration
+
+    def initialize(abstract_model)
+      @abstract_model = abstract_model
+    end
+
+    def tree?
+      tree.present?
+    end
+
+    def list?
+      list.present? && !tree?
+    end
+
+    def options
+      if tree?
+        @nestable_options ||= (tree.class == Hash ? tree : {})
+      elsif list?
+        @nestable_options ||= { position_field: :position, max_depth: 1 }.merge(list.class == Hash ? list : {})
+      end
+
+      @nestable_options || {}
+    end
+
+  protected
+
+    def tree
+      @nestable_tree ||= ::RailsAdmin::Config.model(@abstract_model.model).nestable_tree
+    end
+
+    def list
+      @nestable_list ||= ::RailsAdmin::Config.model(@abstract_model.model).nestable_list
+    end
+
+  end
+end

data/lib/rails_admin_nestable/engine.rb

@@ -0,0 +1,4 @@
+module RailsAdminNestable
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_admin_nestable/helper.rb

@@ -0,0 +1,36 @@
+module RailsAdminNestable
+  module Helper
+
+    def nested_tree_nodes(tree_nodes = [])
+      tree_nodes.map do |tree_node, sub_tree_nodes|
+        li_classes = 'dd-item dd3-item'
+
+        content_tag :li, class: li_classes, :'data-id' => tree_node.id do
+
+          output = content_tag :div, 'drag', class: 'dd-handle dd3-handle'
+          output+= content_tag :div, class: 'dd3-content' do
+            content = link_to @model_config.with(object: tree_node).object_label, edit_path(@abstract_model, tree_node.id)
+            content+= content_tag :div, action_links(tree_node), class: 'pull-right links'
+          end
+
+          if sub_tree_nodes && sub_tree_nodes.any?
+            output+= content_tag :ol, nested_tree_nodes(sub_tree_nodes), class: 'dd-list'
+          end
+
+          output
+        end
+      end.join.html_safe
+    end
+
+    def action_links(model)
+      content_tag :ul, class: 'inline actions' do
+        menu_for :member, @abstract_model, model, true
+      end
+    end
+
+    def tree_max_depth
+      @nestable_conf.options[:max_depth] || 'false'
+    end
+
+  end
+end

data/lib/rails_admin_nestable/model.rb

@@ -0,0 +1,15 @@
+module RailsAdmin
+  module Config
+    class Model
+
+      register_instance_option :nestable_tree do
+        nil
+      end
+
+      register_instance_option :nestable_list do
+        nil
+      end
+
+    end
+  end
+end

data/lib/rails_admin_nestable/nestable.rb

@@ -0,0 +1,93 @@
+module RailsAdmin
+  module Config
+    module Actions
+      class Nestable < Base
+        RailsAdmin::Config::Actions.register(self)
+
+        # Is the action acting on the root level (Example: /admin/contact)
+        register_instance_option :root? do
+          false
+        end
+
+        register_instance_option :collection? do
+          true
+        end
+
+        # Is the action on an object scope (Example: /admin/team/1/edit)
+        register_instance_option :member? do
+          false
+        end
+
+        register_instance_option :controller do
+          Proc.new do |klass|
+            @nestable_conf = ::RailsAdminNestable::Configuration.new @abstract_model
+
+            def update_tree(tree_nodes, parent_node = nil)
+              tree_nodes.each do |key, value|
+                model = @abstract_model.model.find(value['id'])
+                model.parent = parent_node if parent_node.present?
+
+                if @nestable_conf.options[:position_field].present?
+                  model.send("#{@nestable_conf.options[:position_field]}=".to_sym, (key.to_i + 1))
+                end
+
+                model.save!(validate: false)
+
+                if value.has_key?('children')
+                  update_tree(value['children'], model)
+                end
+              end
+            end
+
+            def update_list(model_list)
+              model_list.each do |key, value|
+                model = @abstract_model.model.find(value['id'])
+                model.send("#{@nestable_conf.options[:position_field]}=".to_sym, (key.to_i + 1))
+                model.save!(validate: false)
+              end
+            end
+
+            if params['tree_nodes'].present?
+              begin
+                ActiveRecord::Base.transaction do
+                  if @nestable_conf.tree?
+                    update_tree params[:tree_nodes]
+                  end
+
+                  if @nestable_conf.list?
+                    update_list params[:tree_nodes]
+                  end
+                end
+                message = "<strong>#{I18n.t('admin.actions.nestable.success')}!</strong>"
+              rescue Exception => e
+                message = "<strong>#{I18n.t('admin.actions.nestable.error')}</strong>: #{e}"
+              end
+
+              render text: message
+            else
+              model_scope = @abstract_model.model.unscoped
+
+              if @nestable_conf.tree?
+                @tree_nodes = model_scope.arrange(order: @nestable_conf.options[:position_field])
+              end
+
+              if @nestable_conf.list?
+                @tree_nodes = model_scope.order(@nestable_conf.options[:position_field])
+              end
+
+              render action: @action.template_name
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          'icon-align-left'
+        end
+
+        register_instance_option :http_methods do
+          [:get, :post]
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_nestable/version.rb

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_nestable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrea Dal Ponte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails_admin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Organise Ancestry model into a drag and drop tree structure
+email:
+- info@andreadalponte.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/rails_admin/rails_admin_nestable.js.coffee
+- app/assets/stylesheets/rails_admin/rails_admin_nestable.css
+- app/helpers/rails_admin/nestable_helper.rb
+- app/views/rails_admin/main/nestable.html.haml
+- config/locales/nestable.en.yml
+- config/locales/nestable.it.yml
+- lib/rails_admin_nestable/configuration.rb
+- lib/rails_admin_nestable/engine.rb
+- lib/rails_admin_nestable/helper.rb
+- lib/rails_admin_nestable/model.rb
+- lib/rails_admin_nestable/nestable.rb
+- lib/rails_admin_nestable/version.rb
+- lib/rails_admin_nestable.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/dalpo/rails_admin_nestable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Organise Ancestry model into a drag and drop tree structure
+test_files: []