RubyGems - bone_tree - Versions diffs - 0.5.6 → 0.9.2 - Mend

bone_tree 0.5.6 → 0.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

data/.gitignore +26 -3
data/Gemfile +5 -12
data/Rakefile +7 -9
data/bone_tree.gemspec +30 -14
data/config.rb +8 -0
data/lib/assets/javascripts/bone_tree.js +277 -981
data/lib/assets/stylesheets/bone_tree.css +108 -0
data/lib/bone_tree/rails.rb +5 -0
data/lib/bone_tree/sprockets.rb +3 -0
data/lib/{version.rb → bone_tree/version.rb} +1 -1
data/lib/bone_tree.rb +11 -6
data/source/index.html.haml +10 -382
data/source/javascripts/{_backbone.js → backbone.js} +282 -142
data/source/javascripts/bone_tree/models/directory.js.coffee +109 -0
data/source/javascripts/bone_tree/models/file.js.coffee +12 -0
data/source/javascripts/bone_tree/models/node.js.coffee +24 -0
data/source/javascripts/bone_tree/models/settings.js.coffee +5 -0
data/source/javascripts/bone_tree/{_namespace.js.coffee → namespace.js.coffee} +1 -1
data/source/javascripts/bone_tree/views/directory.js.coffee +56 -0
data/source/javascripts/bone_tree/views/file.js.coffee +25 -0
data/source/javascripts/bone_tree/views/tree.js.coffee +87 -0
data/source/javascripts/bone_tree.js.coffee +2 -1
data/source/stylesheets/bone_tree.css.sass +0 -38
data/spec/javascripts/directory_spec.coffee +26 -0
data/spec/javascripts/helpers/spec_helper.coffee +3 -4
data/spec/javascripts/sorting_spec.coffee +12 -0
data/spec/javascripts/support/jasmine.yml +6 -4
metadata +143 -36
data/Gemfile.lock +0 -190
data/docs/index.html +0 -222
data/docs/resources/base.css +0 -70
data/docs/resources/index.css +0 -20
data/docs/resources/module.css +0 -24
data/docs/source/javascripts/bone_tree/_namespace.js.html +0 -45
data/docs/source/javascripts/bone_tree/models/_directory.js.html +0 -126
data/docs/source/javascripts/bone_tree/models/_file.js.html +0 -112
data/docs/source/javascripts/bone_tree/models/_nodes.js.html +0 -174
data/docs/source/javascripts/bone_tree/models/_settings.js.html +0 -75
data/docs/source/javascripts/bone_tree/views/_directory.js.html +0 -94
data/docs/source/javascripts/bone_tree/views/_file.js.html +0 -82
data/docs/source/javascripts/bone_tree/views/_menu.js.html +0 -110
data/docs/source/javascripts/bone_tree/views/_tree.js.html +0 -432
data/source/javascripts/_jquery.min.js +0 -5
data/source/javascripts/_underscore.js +0 -999
data/source/javascripts/bone_tree/models/_directory.js.coffee +0 -63
data/source/javascripts/bone_tree/models/_file.js.coffee +0 -55
data/source/javascripts/bone_tree/models/_nodes.js.coffee +0 -117
data/source/javascripts/bone_tree/models/_settings.js.coffee +0 -25
data/source/javascripts/bone_tree/views/_directory.js.coffee +0 -73
data/source/javascripts/bone_tree/views/_file.js.coffee +0 -51
data/source/javascripts/bone_tree/views/_menu.js.coffee +0 -97
data/source/javascripts/bone_tree/views/_tree.js.coffee +0 -498
data/spec/javascripts/directory_view_spec.coffee +0 -91
data/spec/javascripts/file_view_spec.coffee +0 -70
data/spec/javascripts/menu_view_spec.coffee +0 -42
data/spec/javascripts/nodes_spec.coffee +0 -37
data/spec/javascripts/tree_view_spec.coffee +0 -39

data/docs/source/javascripts/bone_tree/models/_file.js.html DELETED Viewed

@@ -1,112 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>_file.js.coffee</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <link rel="stylesheet" media="all" href="../../../../resources/base.css" />
-  <link rel="stylesheet" media="all" href="../../../../resources/module.css" />
-</head>
-<body>
-  <header>
-    <h1>_file.js.coffee</h1>
-  </header>
-  <div id="content">
-    <div id="sidebar">
-      <h4>Classes</h4>
-      <ul class="classlist">
-        <li><a href="#Models.File">Models.File</a></li>
-      </ul>
-      <h4>Functions</h4>
-      <ul class="functionlist">
-        <li><a href="#Models.File.createFromFileName">Models.File.createFromFileName</a></li>
-      </ul>
-    </div>
-    <div id="main">
-      <div id="classes">
-        <h2>Classes</h2>
-        <div class="class">
-          <div class="header">
-            <a id="Models.File"><h3>Models.File</h3></a>
-            <a class="parent" href="#Models.Node"><h3>extends Models.Node</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Public: Object representing file data in the tree.</p>
-<ul>
-<li>defaults
-<ul><li>name         - A String naming the file (default: "New File").</li>
-<li>sortPriority - A String representing the priority with which the
-           node is sorted. Directories have sortPriority "0"
-           allowing them to be sorted before Files which have
-           sortPriority "1".</li>
-<li>nodeType     - A String denoting what type of node this object is.
-           The two types are "file" and "directory".</li></ul></li>
-</ul>
-            <div class="methods">
-            </div>
-          </div>
-        </div>
-      </div>
-      <div id="functions">
-        <h2>Functions</h2>
-        <div class="function">
-          <div class="header">
-            <a id="Models.File.createFromFileName"><h3>Models.File.createFromFileName(fileName, fileData)</h3></a>
-          </div>
-          <div>
-            <p>Public: Class method to create a new File object based on the fileName
-        and fileData passed in.</p>
-<ul>
-<li><p>fileName - A String representing the name of the file to be created.
-         files with '.' in the name will be parsed out and only the
-         string after the final '.' will be considered the extension.</p></li>
-<li><p>fileData - An Object of attributes to associate with the file.</p></li>
-</ul>
-<p>Examples</p>
-<pre><code>data = {
-  contents: alert 'this is the code in the file'
-  createdAt: 1330846900589
-  language: 'CoffeeScript'
-}
-BoneTree.Models.File.createFromFileName('example.coffee', data)
-# =&gt; &lt;File&gt;
-</code></pre>
-<p>Returns the File object just created.</p>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</body>
-</html>

data/docs/source/javascripts/bone_tree/models/_nodes.js.html DELETED Viewed

@@ -1,174 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>_nodes.js.coffee</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <link rel="stylesheet" media="all" href="../../../../resources/base.css" />
-  <link rel="stylesheet" media="all" href="../../../../resources/module.css" />
-</head>
-<body>
-  <header>
-    <h1>_nodes.js.coffee</h1>
-  </header>
-  <div id="content">
-    <div id="sidebar">
-      <h4>Classes</h4>
-      <ul class="classlist">
-        <li><a href="#Models.Node">Models.Node</a></li>
-        <li><a href="#Models.Nodes">Models.Nodes</a></li>
-      </ul>
-    </div>
-    <div id="main">
-      <div id="classes">
-        <h2>Classes</h2>
-        <div class="class">
-          <div class="header">
-            <a id="Models.Node"><h3>Models.Node</h3></a>
-            <a class="parent" href="#Backbone.Model"><h3>extends Backbone.Model</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Internal: An abstract super class for File and Directory objects to inherit from.</p>
-            <div class="methods">
-              <div class="instancemethods">
-                <h3>Instance Methods</h3>
-                <div class="method">
-                  <h4>initialize()</h4>
-                  <p>Internal: Initialize a new Node object. Set it up to contain a collection of
-          children nodes.</p>
-                </div>
-                <div class="method">
-                  <h4>constantize()</h4>
-                  <p>Public: Returns a String with the nodeType capitalized so that it may be used
-        to instatiate the appropriate view type</p>
-<p>Examples</p>
-<pre><code>file = new BoneTree.Models.File
-directory = new BoneTree.Models.Directory
-file.constantize()
-# =&gt; 'File'
-directory.constantize()
-# =&gt; 'Directory'
-# use it to create a new view of the appropriate type
-view = new BoneTree.Views[file.constantize()]
-</code></pre>
-<p>Returns a String of the nodeType with the first letter capitalized.</p>
-                </div>
-                <div class="method">
-                  <h4>nameWithExtension()</h4>
-                  <p>Public: Returns the node name with the extension if it has
-        one and just the node name if there is no extension.</p>
-<p>Examples</p>
-<pre><code>file = new BoneTree.Models.File
-  name: "file"
-  extension: "coffee"
-noExt = new BoneTree.Models.File
-  name: "file2"
-directory = new BoneTree.Model.Directory
-  name: "source"
-file.nameWithExtension()
-# =&gt; "file.coffee"
-noExt.nameWithExtension()
-# =&gt; "file2"
-directory.nameWithExtension()
-# =&gt; "source"
-</code></pre>
-<p>Returns a String. If the extension exists then the node name plus the extension
-are returned. If there is no extension, then just the node name is returned.</p>
-                </div>
-              </div>
-            </div>
-          </div>
-        </div>
-        <div class="class">
-          <div class="header">
-            <a id="Models.Nodes"><h3>Models.Nodes</h3></a>
-            <a class="parent" href="#Backbone.Collection"><h3>extends Backbone.Collection</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Internal: A collection of node models. Since Node is an abstract super
-          class, in practice this collection will hold File objects
-          and Directory objects.</p>
-            <div class="methods">
-              <div class="instancemethods">
-                <h3>Instance Methods</h3>
-                <div class="method">
-                  <h4>comparator(node)</h4>
-                  <p>Internal: Function that determines how the file tree is sorted. Directories
-          are sorted before files. After node type sort
-          priority, nodes are sorted by name.</p>
-<p>Examples</p>
-<pre><code>tree.addFile('/source/file1.coffee')
-tree.addFile('/source/file2.coffee')
-tree.addFile('main.coffee')
-tree.render()
-# even though 'main' comes before 'source' alphabetically it is placed
-# after the 'source' directory due to the sortPriority of the Directory object.
-tree.toAscii()
-# =&gt; "
-  -source
-   -file1.coffee
-   -file2.coffee
-  -main.coffee
-"
-</code></pre>
-                </div>
-              </div>
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</body>
-</html>

data/docs/source/javascripts/bone_tree/models/_settings.js.html DELETED Viewed

@@ -1,75 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>_settings.js.coffee</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <link rel="stylesheet" media="all" href="../../../../resources/base.css" />
-  <link rel="stylesheet" media="all" href="../../../../resources/module.css" />
-</head>
-<body>
-  <header>
-    <h1>_settings.js.coffee</h1>
-  </header>
-  <div id="content">
-    <div id="sidebar">
-      <h4>Classes</h4>
-      <ul class="classlist">
-        <li><a href="#Models.Settings">Models.Settings</a></li>
-      </ul>
-    </div>
-    <div id="main">
-      <div id="classes">
-        <h2>Classes</h2>
-        <div class="class">
-          <div class="header">
-            <a id="Models.Settings"><h3>Models.Settings</h3></a>
-            <a class="parent" href="#Backbone.Model"><h3>extends Backbone.Model</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Internal: A configuration object. Consumers of the API don't need to
-          worry about this. It is used internally to manage the options
-          passed into the file tree.</p>
-<ul>
-<li>defaults
-<ul><li>autoOpenFiles  - A Boolean. If true, each file that is added to the tree
-             immediately triggers an <code>openFile</code> event (default: true).</li>
-<li>beforeAdd      - A Function that is invoked before each file is added to the tree.
-         It is passed the raw file attributes and should return true if
-             that file should be added to the tree and false if not. The
-             default implementation is to return true.</li>
-<li>confirmDeletes - A Boolean. If true, the tree will prompt the user, making
-             sure they want to delete the file (default: false).</li>
-<li>showExtensions - A Boolean. If true, files display their extensions. Internally,
-             extensions are always kept track of but by default they are
-             hidden (default: false).</li>
-<li>viewCache      - An Object that stores views when they are created and is used
-             to look them up to prevent extra views from being created.</li></ul></li>
-</ul>
-            <div class="methods">
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</body>
-</html>

data/docs/source/javascripts/bone_tree/views/_directory.js.html DELETED Viewed

@@ -1,94 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>_directory.js.coffee</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <link rel="stylesheet" media="all" href="../../../../resources/base.css" />
-  <link rel="stylesheet" media="all" href="../../../../resources/module.css" />
-</head>
-<body>
-  <header>
-    <h1>_directory.js.coffee</h1>
-  </header>
-  <div id="content">
-    <div id="sidebar">
-      <h4>Classes</h4>
-      <ul class="classlist">
-        <li><a href="#Views.Directory">Views.Directory</a></li>
-      </ul>
-    </div>
-    <div id="main">
-      <div id="classes">
-        <h2>Classes</h2>
-        <div class="class">
-          <div class="header">
-            <a id="Views.Directory"><h3>Views.Directory</h3></a>
-            <a class="parent" href="#Backbone.View"><h3>extends Backbone.View</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Internal: View that renders a Directory node and controls its behavior (class: 'directory', tag: 'ul').</p>
-            <div class="methods">
-              <div class="instancemethods">
-                <h3>Instance Methods</h3>
-                <div class="method">
-                  <h4>initialize(options)</h4>
-                  <p>Internal: Initialize a new directory node. Adds associated model cid to the
-          view element. Binds change handler to the <code>change:open</code> event that
-          toggles the display of directory contents. Binds change handler to
-          the <code>change:name</code> event that re-renders a sorted file tree.</p>
-<ul>
-<li>options - Passes in settings object, which is used for access to the
-        tree view root in order to proxy events to it.</li>
-</ul>
-                </div>
-                <div class="method">
-                  <h4>appendView(node)</h4>
-                  <p>Internal: Appends a view based on the underlying node model to this view.</p>
-<p>node - A Node model. Either a File or a Directory. This is the model the
-       created view will be associated with.</p>
-                </div>
-                <div class="method">
-                  <h4>render()</h4>
-                  <p>Internal: Set the text of the view element based on the underlying model name.</p>
-<p>Returns <code>this</code> view.</p>
-                </div>
-                <div class="method">
-                  <h4>displayChildren(open)</h4>
-                  <p>Internal: Toggles display of the children Files or Diretories of this view.</p>
-                </div>
-              </div>
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</body>
-</html>

data/docs/source/javascripts/bone_tree/views/_file.js.html DELETED Viewed

@@ -1,82 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>_file.js.coffee</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <link rel="stylesheet" media="all" href="../../../../resources/base.css" />
-  <link rel="stylesheet" media="all" href="../../../../resources/module.css" />
-</head>
-<body>
-  <header>
-    <h1>_file.js.coffee</h1>
-  </header>
-  <div id="content">
-    <div id="sidebar">
-      <h4>Classes</h4>
-      <ul class="classlist">
-        <li><a href="#Views.File">Views.File</a></li>
-      </ul>
-    </div>
-    <div id="main">
-      <div id="classes">
-        <h2>Classes</h2>
-        <div class="class">
-          <div class="header">
-            <a id="Views.File"><h3>Views.File</h3></a>
-            <a class="parent" href="#Backbone.View"><h3>extends Backbone.View</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Internal: View that renders a File node and controls its behavior (class: 'file', tag: 'li').</p>
-            <div class="methods">
-              <div class="instancemethods">
-                <h3>Instance Methods</h3>
-                <div class="method">
-                  <h4>initialize(options)</h4>
-                  <p>Internal: Initialize a new file node. Adds associated model cid to the
-          view element. Binds change handlers to the <code>change:name</code> and
-          <code>change:extension</code> events. These take care of resorting the file
-          nodes.</p>
-<ul>
-<li>options - Passes in settings object, which is used to control
-        whether or not file extensions are shown.</li>
-</ul>
-                </div>
-                <div class="method">
-                  <h4>render()</h4>
-                  <p>Internal: Sets the text of the file node according to the underlying model
-          name. If the 'showExtensions' setting is set, renders the
-          full file name with extension, otherwise renders just the file
-          name attribute.</p>
-                </div>
-              </div>
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</body>
-</html>

data/docs/source/javascripts/bone_tree/views/_menu.js.html DELETED Viewed

@@ -1,110 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>_menu.js.coffee</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <link rel="stylesheet" media="all" href="../../../../resources/base.css" />
-  <link rel="stylesheet" media="all" href="../../../../resources/module.css" />
-</head>
-<body>
-  <header>
-    <h1>_menu.js.coffee</h1>
-  </header>
-  <div id="content">
-    <div id="sidebar">
-      <h4>Classes</h4>
-      <ul class="classlist">
-        <li><a href="#Views.Menu">Views.Menu</a></li>
-      </ul>
-    </div>
-    <div id="main">
-      <div id="classes">
-        <h2>Classes</h2>
-        <div class="class">
-          <div class="header">
-            <a id="Views.Menu"><h3>Views.Menu</h3></a>
-            <a class="parent" href="#Backbone.View"><h3>extends Backbone.View</h3></a>
-          </div>
-          <div class="class_content">
-            <p>Internal: View that controls the context menu (class: 'filetree_context_menu').</p>
-<p>Events</p>
-<ul>
-<li><p>contextMenu   - Prevents the standard browser context menu from appearing
-              when right clicking within the file tree context menu.</p></li>
-<li><p>click .rename - Prompts the user to rename a file.</p></li>
-<li><p>click .delete - Deletes a node from the file tree.</p></li>
-</ul>
-            <div class="methods">
-              <div class="instancemethods">
-                <h3>Instance Methods</h3>
-                <div class="method">
-                  <h4>initialize(options)</h4>
-                  <p>Internal: Initialize a new menu widget.</p>
-<ul>
-<li>options - An Object. Internally used to pass the settings configuration
-        into the menu. This controls whether or not the user is
-        prompted to confirm deleting a file.</li>
-</ul>
-                </div>
-                <div class="method">
-                  <h4>contextMenu(e)</h4>
-                  <p>Internal: Kill the default browser behavior for the contextmenu event.</p>
-                </div>
-                <div class="method">
-                  <h4>delete(e)</h4>
-                  <p>Internal: Deletes a node from the file tree. If the confirmDeletes setting
-          is set, prompts the user for delete confirmation.</p>
-                </div>
-                <div class="method">
-                  <h4>rename(e)</h4>
-                  <p>Internal: Prompts the user to rename a File or Directory.</p>
-                </div>
-                <div class="method">
-                  <h4>render()</h4>
-                  <p>Internal: Renders the <ul> that contains the context menu choices
-          'Rename' and 'Delete'.</p>
-<p>Returns <code>this</code>, the menu view.</p>
-                </div>
-                <div class="method">
-                  <h4>template()</h4>
-                  <p>Internal: html template for the context menu.</p>
-                </div>
-              </div>
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</body>
-</html>