rails_admin-treeview 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_admin-treeview.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nick Recobra
+
+MIT License
+
+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,47 @@
+# RailsAdmin::Treeview
+
+Tree-style navigation for RailsAdmin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_admin-treeview'
+
+And then execute:
+
+    $ bundle
+
+Be sure to have [rails_admin](https://github.com/sferik/rails_admin) gem installed.
+
+## Usage
+
+Configure your model to use Treeview in rails_admin.rb:
+
+    RailsAdmin.config do |config|
+      config.model Category do
+        treeview true
+      end
+    end
+
+Note that your model should implement these methods to use Treeview: 
+* `roots` class method that returns all root elements;
+* `children` instance method that returns all of the object's child items.
+
+Tree could be rendered expanded or collapsed. In order to be able to
+change this, copy and edit
+`app/views/layouts/rails_admin/_navigation.html.haml` by running a
+generator:
+
+    rails g rails_admin:treeview
+
+Now you could pass true of false to the `treeview` helper to render tree
+expanded or collapsed.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/helpers/rails_admin_treeview_helper.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module RailsAdminTreeviewHelper
+  def treeview open = false
+    if @model_config && @model_config.treeview
+      raise "Your #{@abstract_model.model} model must implement `roots` class method and `children` instance method to use treeview." if
+        !@abstract_model.model.respond_to?(:roots) || !@abstract_model.model.public_instance_methods.include?("children")
+      res = ''
+      res << javascript_include_tag("jquery.treeview.js")
+      res << stylesheet_link_tag("jquery.treeview.css")
+      res << "<hr>"
+      res << "<h3>%s</h3>" % @model_config.label_plural
+      res << (content_tag :ul, :id => "treeview" do
+        @abstract_model.model.roots.map do |root|
+          treeview_draw(root, open)
+        end.join.html_safe
+      end)
+      res << javascript_tag('$(document).ready(function(){$("#treeview").treeview({persist: "location"});});')
+      res.html_safe
+    end
+  end
+
+  def treeview_draw node, open
+    content_tag :li, :class => open ? nil : "closed" do
+      res = ''
+      name = RailsAdmin.config(node.class).with(:object => node).object_label
+      res << content_tag(:span, link_to_unless_current(name, { :action => "edit",
+                                                :id => node.id,
+                                                :host => request.host,
+                                                :port => request.port == 80 ? nil : request.port,
+                                                :protocol => request.scheme }))
+      if node.children.size > 0
+        res << (content_tag :ul do
+          node.children.map do |child|
+            treeview_draw(child, open)
+          end.join.html_safe
+        end)
+      end
+      res.html_safe
+    end
+  end
+end

data/app/views/layouts/rails_admin/_navigation.html.haml

@@ -0,0 +1,20 @@
+- models = RailsAdmin::Config.visible_models.select { |model| authorized?(:index, model.abstract_model) }
+- root_models = models.select { |model| model.parent == :root }
+
+%ul#nav.navigation
+  %li{:class => ("active" if @page_type == "dashboard")}
+    = link_to(t("admin.dashboard.name"), dashboard_path)
+  - root_models.each do |model|
+    - children = [model] + models.select { |m| m.parent.to_s == model.abstract_model.model.to_s }
+    - tab_titles = children.map { |child| child.abstract_model.pretty_name.downcase }
+    - active = tab_titles.include? @page_type
+    %li{:class => "#{"active" if active} #{"more" unless children.empty?}"}
+      - if children.size == 1
+        = link_to(model.label_plural, index_path(:model_name => model.abstract_model.to_param))
+      - else
+        = model.navigation_label ? t(model.navigation_label, :default => model.navigation_label) : model.label_plural
+        %ul
+          - children.each_with_index do |child, index|
+            %li{:class => ("active" if @page_type == tab_titles[index])}
+              = link_to(child.label_plural, index_path(:model_name => child.abstract_model.to_param))
+= treeview true

data/lib/generators/rails_admin/treeview_generator.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module RailsAdmin
+  class TreeviewGenerator < Rails::Generators::Base
+    class << self
+      def source_root
+        File.expand_path("../../../../app", __FILE__)
+      end
+    end
+
+    def copy_views
+      copy_file "views/layouts/rails_admin/_navigation.html.haml", "app/views/layouts/rails_admin/_navigation.html.haml"
+    end
+  end
+end
+

data/lib/rails_admin-treeview.rb

@@ -0,0 +1,14 @@
+require "rails_admin-treeview/version"
+require "rails_admin"
+require "rails_admin-treeview/config/model"
+
+module RailsAdmin
+  module Treeview
+    class Engine < Rails::Engine
+      initializer 'rails_admin-treeview.helper' do |app|
+        ActionView::Base.send :include, RailsAdminTreeviewHelper
+      end
+    end
+  end
+end
+

data/lib/rails_admin-treeview/config/model.rb

@@ -0,0 +1,9 @@
+module RailsAdmin
+  module Config
+    class Model < RailsAdmin::Config::Base
+      register_instance_option(:treeview) do
+        false
+      end
+    end
+  end
+end

data/lib/rails_admin-treeview/version.rb

@@ -0,0 +1,5 @@
+module RailsAdmin
+  module Treeview
+    VERSION = "1.0.0"
+  end
+end

data/rails_admin-treeview.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails_admin-treeview/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Recobra"]
+  gem.email         = ["oruenu@gmail.com"]
+  gem.description   = %q{Tree-style sidebar navigation}
+  gem.summary       = %q{Implements treeview via jquery.treeview for models}
+  gem.homepage      = "http://github.com/oruen/rails_admin-treeview"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rails_admin-treeview"
+  gem.require_paths = ["lib"]
+  gem.add_dependency "jquery-rails", ">= 1.0"
+  gem.version       = RailsAdmin::Treeview::VERSION
+end

data/vendor/assets/javascripts/jquery.treeview.js

@@ -0,0 +1,256 @@
+/*
+ * Treeview 1.5pre - jQuery plugin to hide and show branches of a tree
+ * 
+ * http://bassistance.de/jquery-plugins/jquery-plugin-treeview/
+ * http://docs.jquery.com/Plugins/Treeview
+ *
+ * Copyright (c) 2007 Jörn Zaefferer
+ *
+ * Dual licensed under the MIT and GPL licenses:
+ *   http://www.opensource.org/licenses/mit-license.php
+ *   http://www.gnu.org/licenses/gpl.html
+ *
+ * Revision: $Id: jquery.treeview.js 5759 2008-07-01 07:50:28Z joern.zaefferer $
+ *
+ */
+
+;(function($) {
+
+	// TODO rewrite as a widget, removing all the extra plugins
+	$.extend($.fn, {
+		swapClass: function(c1, c2) {
+			var c1Elements = this.filter('.' + c1);
+			this.filter('.' + c2).removeClass(c2).addClass(c1);
+			c1Elements.removeClass(c1).addClass(c2);
+			return this;
+		},
+		replaceClass: function(c1, c2) {
+			return this.filter('.' + c1).removeClass(c1).addClass(c2).end();
+		},
+		hoverClass: function(className) {
+			className = className || "hover";
+			return this.hover(function() {
+				$(this).addClass(className);
+			}, function() {
+				$(this).removeClass(className);
+			});
+		},
+		heightToggle: function(animated, callback) {
+			animated ?
+				this.animate({ height: "toggle" }, animated, callback) :
+				this.each(function(){
+					jQuery(this)[ jQuery(this).is(":hidden") ? "show" : "hide" ]();
+					if(callback)
+						callback.apply(this, arguments);
+				});
+		},
+		heightHide: function(animated, callback) {
+			if (animated) {
+				this.animate({ height: "hide" }, animated, callback);
+			} else {
+				this.hide();
+				if (callback)
+					this.each(callback);				
+			}
+		},
+		prepareBranches: function(settings) {
+			if (!settings.prerendered) {
+				// mark last tree items
+				this.filter(":last-child:not(ul)").addClass(CLASSES.last);
+				// collapse whole tree, or only those marked as closed, anyway except those marked as open
+				this.filter((settings.collapsed ? "" : "." + CLASSES.closed) + ":not(." + CLASSES.open + ")").find(">ul").hide();
+			}
+			// return all items with sublists
+			return this.filter(":has(>ul)");
+		},
+		applyClasses: function(settings, toggler) {
+			// TODO use event delegation
+			this.filter(":has(>ul):not(:has(>a))").find(">span").unbind("click.treeview").bind("click.treeview", function(event) {
+				// don't handle click events on children, eg. checkboxes
+				if ( this == event.target )
+					toggler.apply($(this).next());
+			}).add( $("a", this) ).hoverClass();
+			
+			if (!settings.prerendered) {
+				// handle closed ones first
+				this.filter(":has(>ul:hidden)")
+						.addClass(CLASSES.expandable)
+						.replaceClass(CLASSES.last, CLASSES.lastExpandable);
+						
+				// handle open ones
+				this.not(":has(>ul:hidden)")
+						.addClass(CLASSES.collapsable)
+						.replaceClass(CLASSES.last, CLASSES.lastCollapsable);
+						
+	            // create hitarea if not present
+				var hitarea = this.find("div." + CLASSES.hitarea);
+				if (!hitarea.length)
+					hitarea = this.prepend("<div class=\"" + CLASSES.hitarea + "\"/>").find("div." + CLASSES.hitarea);
+				hitarea.removeClass().addClass(CLASSES.hitarea).each(function() {
+					var classes = "";
+					$.each($(this).parent().attr("class").split(" "), function() {
+						classes += this + "-hitarea ";
+					});
+					$(this).addClass( classes );
+				})
+			}
+			
+			// apply event to hitarea
+			this.find("div." + CLASSES.hitarea).click( toggler );
+		},
+		treeview: function(settings) {
+			
+			settings = $.extend({
+				cookieId: "treeview"
+			}, settings);
+			
+			if ( settings.toggle ) {
+				var callback = settings.toggle;
+				settings.toggle = function() {
+					return callback.apply($(this).parent()[0], arguments);
+				};
+			}
+		
+			// factory for treecontroller
+			function treeController(tree, control) {
+				// factory for click handlers
+				function handler(filter) {
+					return function() {
+						// reuse toggle event handler, applying the elements to toggle
+						// start searching for all hitareas
+						toggler.apply( $("div." + CLASSES.hitarea, tree).filter(function() {
+							// for plain toggle, no filter is provided, otherwise we need to check the parent element
+							return filter ? $(this).parent("." + filter).length : true;
+						}) );
+						return false;
+					};
+				}
+				// click on first element to collapse tree
+				$("a:eq(0)", control).click( handler(CLASSES.collapsable) );
+				// click on second to expand tree
+				$("a:eq(1)", control).click( handler(CLASSES.expandable) );
+				// click on third to toggle tree
+				$("a:eq(2)", control).click( handler() ); 
+			}
+		
+			// handle toggle event
+			function toggler() {
+				$(this)
+					.parent()
+					// swap classes for hitarea
+					.find(">.hitarea")
+						.swapClass( CLASSES.collapsableHitarea, CLASSES.expandableHitarea )
+						.swapClass( CLASSES.lastCollapsableHitarea, CLASSES.lastExpandableHitarea )
+					.end()
+					// swap classes for parent li
+					.swapClass( CLASSES.collapsable, CLASSES.expandable )
+					.swapClass( CLASSES.lastCollapsable, CLASSES.lastExpandable )
+					// find child lists
+					.find( ">ul" )
+					// toggle them
+					.heightToggle( settings.animated, settings.toggle );
+				if ( settings.unique ) {
+					$(this).parent()
+						.siblings()
+						// swap classes for hitarea
+						.find(">.hitarea")
+							.replaceClass( CLASSES.collapsableHitarea, CLASSES.expandableHitarea )
+							.replaceClass( CLASSES.lastCollapsableHitarea, CLASSES.lastExpandableHitarea )
+						.end()
+						.replaceClass( CLASSES.collapsable, CLASSES.expandable )
+						.replaceClass( CLASSES.lastCollapsable, CLASSES.lastExpandable )
+						.find( ">ul" )
+						.heightHide( settings.animated, settings.toggle );
+				}
+			}
+			this.data("toggler", toggler);
+			
+			function serialize() {
+				function binary(arg) {
+					return arg ? 1 : 0;
+				}
+				var data = [];
+				branches.each(function(i, e) {
+					data[i] = $(e).is(":has(>ul:visible)") ? 1 : 0;
+				});
+				$.cookie(settings.cookieId, data.join(""), settings.cookieOptions );
+			}
+			
+			function deserialize() {
+				var stored = $.cookie(settings.cookieId);
+				if ( stored ) {
+					var data = stored.split("");
+					branches.each(function(i, e) {
+						$(e).find(">ul")[ parseInt(data[i]) ? "show" : "hide" ]();
+					});
+				}
+			}
+			
+			// add treeview class to activate styles
+			this.addClass("treeview");
+			
+			// prepare branches and find all tree items with child lists
+			var branches = this.find("li").prepareBranches(settings);
+			
+			switch(settings.persist) {
+			case "cookie":
+				var toggleCallback = settings.toggle;
+				settings.toggle = function() {
+					serialize();
+					if (toggleCallback) {
+						toggleCallback.apply(this, arguments);
+					}
+				};
+				deserialize();
+				break;
+			case "location":
+				var current = this.find("a").filter(function() {
+					return this.href.toLowerCase() == location.href.toLowerCase();
+				});
+				if ( current.length ) {
+					// TODO update the open/closed classes
+					var items = current.addClass("selected").parents("ul, li").add( current.next() ).show();
+					if (settings.prerendered) {
+						// if prerendered is on, replicate the basic class swapping
+						items.filter("li")
+							.swapClass( CLASSES.collapsable, CLASSES.expandable )
+							.swapClass( CLASSES.lastCollapsable, CLASSES.lastExpandable )
+							.find(">.hitarea")
+								.swapClass( CLASSES.collapsableHitarea, CLASSES.expandableHitarea )
+								.swapClass( CLASSES.lastCollapsableHitarea, CLASSES.lastExpandableHitarea );
+					}
+				}
+				break;
+			}
+			
+			branches.applyClasses(settings, toggler);
+				
+			// if control option is set, create the treecontroller and show it
+			if ( settings.control ) {
+				treeController(this, settings.control);
+				$(settings.control).show();
+			}
+			
+			return this;
+		}
+	});
+	
+	// classes used by the plugin
+	// need to be styled via external stylesheet, see first example
+	$.treeview = {};
+	var CLASSES = ($.treeview.classes = {
+		open: "open",
+		closed: "closed",
+		expandable: "expandable",
+		expandableHitarea: "expandable-hitarea",
+		lastExpandableHitarea: "lastExpandable-hitarea",
+		collapsable: "collapsable",
+		collapsableHitarea: "collapsable-hitarea",
+		lastCollapsableHitarea: "lastCollapsable-hitarea",
+		lastCollapsable: "lastCollapsable",
+		lastExpandable: "lastExpandable",
+		last: "last",
+		hitarea: "hitarea"
+	});
+	
+})(jQuery);

data/vendor/assets/stylesheets/jquery.treeview.css

@@ -0,0 +1,74 @@
+.treeview, .treeview ul { 
+	padding: 0;
+	margin: 0;
+	list-style: none;
+}
+
+.treeview ul {
+	/*background-color: white;*/
+	margin-top: 4px;
+}
+
+.treeview .hitarea {
+	background: url(/assets/jquery_treeview/treeview-default.gif) -64px -25px no-repeat;
+	height: 16px;
+	width: 16px;
+	margin-left: -16px;
+	float: left;
+	cursor: pointer;
+}
+/* fix for IE6 */
+* html .hitarea {
+	display: inline;
+	float:none;
+}
+
+.treeview li { 
+	margin: 0;
+	padding: 3px 0pt 3px 16px;
+}
+
+.treeview a.selected {
+	background-color: #eee;
+}
+
+#treecontrol { margin: 1em 0; display: none; }
+
+.treeview .hover { color: red; cursor: pointer; }
+
+.treeview li { background: url(/assets/jquery_treeview/treeview-default-line.gif) 0 0 no-repeat; }
+.treeview li.collapsable, .treeview li.expandable { background-position: 0 -176px; }
+
+.treeview .expandable-hitarea { background-position: -80px -3px; }
+
+.treeview li.last { background-position: 0 -1766px }
+.treeview li.lastCollapsable, .treeview li.lastExpandable { background-image: url(/assets/jquery_treeview/treeview-default.gif); }  
+.treeview li.lastCollapsable { background-position: 0 -111px }
+.treeview li.lastExpandable { background-position: -32px -67px }
+
+.treeview div.lastCollapsable-hitarea, .treeview div.lastExpandable-hitarea { background-position: 0; }
+
+.treeview-red li { background-image: url(/assets/jquery_treeview/treeview-red-line.gif); }
+.treeview-red .hitarea, .treeview-red li.lastCollapsable, .treeview-red li.lastExpandable { background-image: url(/assets/jquery_treeview/treeview-red.gif); } 
+
+.treeview-black li { background-image: url(/assets/jquery_treeview/treeview-black-line.gif); }
+.treeview-black .hitarea, .treeview-black li.lastCollapsable, .treeview-black li.lastExpandable { background-image: url(/assets/jquery_treeview/treeview-black.gif); }  
+
+.treeview-gray li { background-image: url(/assets/jquery_treeview/treeview-gray-line.gif); }
+.treeview-gray .hitarea, .treeview-gray li.lastCollapsable, .treeview-gray li.lastExpandable { background-image: url(/assets/jquery_treeview/treeview-gray.gif); } 
+
+.treeview-famfamfam li { background-image: url(/assets/jquery_treeview/treeview-famfamfam-line.gif); }
+.treeview-famfamfam .hitarea, .treeview-famfamfam li.lastCollapsable, .treeview-famfamfam li.lastExpandable { background-image: url(/assets/jquery_treeview/treeview-famfamfam.gif); } 
+
+.treeview .placeholder {
+	background: url(/assets/jquery_treeview/ajax-loader.gif) 0 0 no-repeat;
+	height: 16px;
+	width: 16px;
+	display: block;
+}
+
+.filetree li { padding: 3px 0 2px 16px; }
+.filetree span.folder, .filetree span.file { padding: 1px 0 1px 16px; display: block; }
+.filetree span.folder { background: url(/assets/jquery_treeview/folder.gif) 0 0 no-repeat; }
+.filetree li.expandable span.folder { background: url(/assets/jquery_treeview/folder-closed.gif) 0 0 no-repeat; }
+.filetree span.file { background: url(/assets/jquery_treeview/file.gif) 0 0 no-repeat; }

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin-treeview
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Recobra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: &2153707780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153707780
+description: Tree-style sidebar navigation
+email:
+- oruenu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/helpers/rails_admin_treeview_helper.rb
+- app/views/layouts/rails_admin/_navigation.html.haml
+- lib/generators/rails_admin/treeview_generator.rb
+- lib/rails_admin-treeview.rb
+- lib/rails_admin-treeview/config/model.rb
+- lib/rails_admin-treeview/version.rb
+- rails_admin-treeview.gemspec
+- vendor/assets/images/jquery_treeview/ajax-loader.gif
+- vendor/assets/images/jquery_treeview/file.gif
+- vendor/assets/images/jquery_treeview/folder-closed.gif
+- vendor/assets/images/jquery_treeview/folder.gif
+- vendor/assets/images/jquery_treeview/minus.gif
+- vendor/assets/images/jquery_treeview/plus.gif
+- vendor/assets/images/jquery_treeview/treeview-black-line.gif
+- vendor/assets/images/jquery_treeview/treeview-black.gif
+- vendor/assets/images/jquery_treeview/treeview-default-line.gif
+- vendor/assets/images/jquery_treeview/treeview-default.gif
+- vendor/assets/images/jquery_treeview/treeview-famfamfam-line.gif
+- vendor/assets/images/jquery_treeview/treeview-famfamfam.gif
+- vendor/assets/images/jquery_treeview/treeview-gray-line.gif
+- vendor/assets/images/jquery_treeview/treeview-gray.gif
+- vendor/assets/images/jquery_treeview/treeview-red-line.gif
+- vendor/assets/images/jquery_treeview/treeview-red.gif
+- vendor/assets/javascripts/jquery.treeview.js
+- vendor/assets/stylesheets/jquery.treeview.css
+homepage: http://github.com/oruen/rails_admin-treeview
+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.6
+signing_key: 
+specification_version: 3
+summary: Implements treeview via jquery.treeview for models
+test_files: []