Merge lp:~rharding/launchpad/bugfix_891735 into lp:launchpad

[Richard Harding]

[r=abentley][bug=891735] create new YUI plugin for auto resizing textarea ui widgets to the formwidget library and add the new widget to the bug report comment textarea

= Summary =
Add a new auto resizing textarea widget for launchpad

== Proposed fix ==
Added a new module under the lp.app.formwidgets namespace called ResizingTextarea. This is a YUI plugin and can be stuck on any textarea YUI node instances.

== Pre-implementation notes ==
Attempted to use a YUI Gallery module that lacked features and performed poorly. Talked with Deryck and we agreed to work on our own module. Deryck pointed me towards the functionality in the inline edit module and to check if we could use that.

I took a peek at the inline editor module, and it does some of the same thing, but it's not modular enough to just use for simple textareas like the initial sample case of the new bug submitting form. It's also less missing some types of changes into the textarea and missing features such as the min and max height code.

Discussed with Deryck and abently and decided that this can proceed, with the understanding that the next goal will be refactoring the inline edit module to use this plugin as a means to manage its own auto resizing behavior. The inline edit will then only need to worry about button, save/cancel events, and such.

== Implementation details ==
The new plugin uses a YUI specific "valueChanged" event for detecting if the content of an input has changed by any means (pasting, key stroke, etc).

It removes the browsers feature for users to resize the textarea via the corner grab point since that can throw off the calculations of the size of the textarea.

It accepts parameters for min and max heights to help duplicate the functionality of defining rows in a textarea.

The adding and removing of rows of space are animated via a css3 transition. It should gracefull degrade on older browsers. There is a flag for turning off all animations. That's used to help keep tests from taking too long to run.

== Tests ==
./bin/test -cvvt test_resizing_textarea.html
$browser lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.html

== Demo and Q/A ==
The tests are the main Q/A right now. The single point where it's created is when adding a new bug. So go to:
https://bugs.launchpad.dev/launchpad/+filebug

Enter a summary, the "Further information" textarea should be an instance of ResizingTextarea and as you enter new lines it will start to expand. There's a default 450px height so at that point, the scrollbar should show up and begin to lengthen.

[Robert Collins (lifeless)]

I'm confused - the bug description editing field already autosizes
(poorly, but it does) - is that not widget already?

[Deryck Hodge (deryck)]

The inline editor widget does resizing as one of among a hundred other things. :) The inline editor's resizing is not reusable at all. For one, the multi-line editor which uses text areas is bound to the same widget for editing single-line text inputs. So the current editor widget is poorly designed and broken in lots of little ways.

I suggested Rick add this current work as a way to plug text areas, thinking it would give us a generic widget for re-use across Launchpad for this pattern, and also give us something to change out to for the resizing bits in the inline editor.

I think fixing the inline editor at the same time as adding this widget is too much. The inline editor is a lot work by itself.

[Aaron Bentley (abentley)]

Rick will be refactoring the inline editor, so the functionality duplication should be short-term.

review: Approve

=== added file 'lib/lp/app/javascript/formwidgets/resizing_textarea.js'
--- lib/lp/app/javascript/formwidgets/resizing_textarea.js	1970-01-01 00:00:00 +0000
+++ lib/lp/app/javascript/formwidgets/resizing_textarea.js	2011-11-24 03:57:28 +0000
@@ -0,0 +1,209 @@
+/**
+ * Copyright 2011 Canonical Ltd. This software is licensed under the
+ * GNU Affero General Public License version 3 (see the file LICENSE).
+ *
+ * Auto Resizing Textarea Widget.
+ *
+ * Usage:
+ *     Y.one('#myid').plug(ResizingTextarea);
+ *     Y.one('#settings').plug(ResizingTextarea, {
+ *         min_height: 100
+ *     });
+ *
+ *     Y.all('textarea').plug(ResizingTextarea);
+ *
+ * @module lp.app.formwidgets
+ * @submodule resizing_textarea
+ */
+YUI.add('lp.app.formwidgets.resizing_textarea', function(Y) {
+
+var module = Y.namespace("lp.app.formwidgets"),
+    ResizingTextarea = function(cfg) {
+        ResizingTextarea.superclass.constructor.apply(this, arguments);
+    };
+
+ResizingTextarea.NAME = "resizing_textarea";
+ResizingTextarea.NS = "resizing_textarea";
+
+/**
+ * ATTRS you can set on initialization to determine how we size the textarea
+ */
+ResizingTextarea.ATTRS = {
+    /**
+     * Min height to allow the textarea to shrink to in px
+     *
+     * We check if there's a css rule for existing height and make that the
+     * min height in case it's there
+     *
+     * @property min_height
+     */
+    min_height: {
+        value: 10,
+
+        valueFn: function () {
+            var target = this.get("host");
+            var css_height = target.getStyle('height');
+
+            return !Y.Lang.isUndefined(css_height) ?
+                this._clean_size(css_height) : undefined;
+        }
+    },
+
+    /**
+     * Max height to allow the textarea to grow to in px
+     *
+     * @property max_height
+     */
+    max_height: {
+        value: 450
+    },
+
+    /**
+     * Should we bypass animating changes in height
+     * Mainly used to turn off for testing to prevent needing to set timeouts
+     *
+     * @property skip_animations
+     */
+    skip_animations: {value: false}
+};
+
+Y.extend(ResizingTextarea, Y.Plugin.Base, {
+
+    // special css we add to clones to make sure they're hidden from view
+    CLONE_CSS: {
+        position: 'absolute',
+        top: -9999,
+        left: -9999,
+        opacity: 0,
+        overflow: 'hidden',
+        resize: 'none'
+    },
+
+    /**
+     * Helper function to turn the string from getComputedStyle to int
+     */
+    _clean_size: function (val) {
+        return parseInt(val.replace('px', ''), 10);
+    },
+
+    // used to track if we're growing/shrinking for each event fired
+    _prev_scroll_height: 0,
+
+    /**
+     * This is the entry point for the event of change
+     *
+     * Here we update the clone and resize based on the update
+     */
+    _run_change: function (new_value) {
+        // we need to update the clone with the content so it resizes
+        this.clone.set('text', new_value);
+        this.resize();
+    },
+
+    /**
+     * Given a node, setup a clone so that we can use it for sizing
+     *
+     * We need to copy this, move it way off the screen and setup some css we
+     * use to make sure that we match the original as best as possible.
+     *
+     * This clone is then checked for the size to use
+     */
+    _setup_clone: function (node) {
+        var clone = node.cloneNode(true);
+
+        clone.setStyles(this.CLONE_CSS);
+        // remove attributes so we don't accidentally grab this node in the
+        // future
+        clone.removeAttribute('id');
+        clone.removeAttribute('name');
+        clone.generateID();
+        clone.setAttrs({
+            'tabIndex': -1,
+            'height': 'auto'
+        });
+        Y.one('body').append(clone);
+
+        return clone;
+    },
+
+    /**
+     * We need to apply some special css to our target we want to resize
+     */
+    _setup_css: function () {
+        // don't let this text area be resized in the browser, it'll mess with
+        // our calcs and we'll be fighting the whole time for the right size
+        this.t_area.setStyle('resize', 'none');
+        this.t_area.setStyle('overflow', 'hidden');
+
+        // we want to add some animation to our adjusting of the size, using
+        // css animation to smooth all height changes
+        if (!this.get('skip_animations')) {
+            this.t_area.setStyle('transition', 'height 0.3s ease');
+            this.t_area.setStyle('-webkit-transition', 'height 0.3s ease');
+            this.t_area.setStyle('-moz-transition', 'height 0.3s ease');
+        }
+    },
+
+    initializer : function(cfg) {
+        this.t_area = this.get("host");
+        this._setup_css(this.t_area);
+
+        // we need to setup the clone of this node so we can check how big it
+        // is, but way off the screen so you don't see it
+        this.clone = this._setup_clone(this.t_area);
+
+        // look at adjusting the size on any value change event including
+        // pasting and such
+        this.t_area.on('valueChange', function(e) {
+            this._run_change(e.newVal);
+        }, this);
+
+        // initial sizing in case there's existing content to match to
+        this.resize();
+    },
+
+    /**
+     * Adjust the size of the textarea as needed
+     *
+     * @method resize
+     */
+    resize: function() {
+        var scroll_height = this.clone.get('scrollHeight');
+
+        // only update the height if we've changed
+        if (this._prev_scroll_height !== scroll_height) {
+            new_height = Math.max(
+                this.get('min_height'),
+                Math.min(scroll_height, this.get('max_height')));
+
+            this.t_area.setStyle('height', new_height);
+
+            // check if the changes above require us to change our overflow
+            // setting to allow for a scrollbar now that our max size has been
+            // reached
+            this.set_overflow();
+
+            this._prev_scroll_height = scroll_height;
+        }
+    },
+
+    /**
+     * Check if we're larger than the max_height setting and enable scrollbar
+     *
+     * @method set_overflow
+     */
+    set_overflow: function() {
+        var overflow = "hidden";
+        if (this.clone.get('scrollHeight') >= this.get('max_height')) {
+            overflow = "auto";
+        }
+        this.t_area.setStyle('overflow', overflow);
+    }
+});
+
+// add onto the formwidget namespace
+module.ResizingTextarea = ResizingTextarea;
+
+}, "0.1", {
+    "requires": ["plugin", "node", "event-valuechange"]
+});

=== added file 'lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.html'
--- lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.html	1970-01-01 00:00:00 +0000
+++ lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.html	2011-11-24 03:57:28 +0000
@@ -0,0 +1,32 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+  <title>Resizing Textarea Plugin</title>
+
+  <!-- YUI and test setup -->
+  <script type="text/javascript"
+          src="../../../../../canonical/launchpad/icing/yui/yui/yui.js">
+  </script>
+  <link rel="stylesheet" href="../../../../app/javascript/testing/test.css" />
+  <script type="text/javascript"
+          src="../../../../app/javascript/testing/testrunner.js"></script>
+
+  <!-- The module under test -->
+  <script type="text/javascript" src="../resizing_textarea.js"></script>
+
+    <!-- The test suite -->
+    <script type="text/javascript" src="test_resizing_textarea.js"></script>
+
+</head>
+<body class="yui3-skin-sam">
+    <!-- We're going to test interacting with dom elements, so let's have some -->
+    <textarea id="init">Initial text</textarea>
+    <textarea id="with_defaults">has defaults</textarea>
+    <textarea id="shrinkage"></textarea>
+    <textarea id="multiple1" class="test_multiple first"></textarea>
+    <textarea id="multiple2" class="test_multiple second"></textarea>
+    <textarea id="css_height" style="height: 120px;"></textarea>
+</body>
+
+</html>

=== added file 'lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.js'
--- lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.js	1970-01-01 00:00:00 +0000
+++ lib/lp/app/javascript/formwidgets/tests/test_resizing_textarea.js	2011-11-24 03:57:28 +0000
@@ -0,0 +1,166 @@
+/* Copyright (c) 2009, Canonical Ltd. All rights reserved. */
+
+YUI().use('lp.testing.runner', 'test', 'console', 'node', 'event',
+          'node-event-simulate', 'event-valuechange', 'plugin',
+          'lp.app.formwidgets.resizing_textarea', function(Y) {
+
+
+var test_text = ["Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+    "Maecenas ut viverra nibh. Morbi sit amet tellus accumsan justo rutrum",
+    "blandit sit amet ac augue. Pellentesque eget diam at purus suscipit",
+    "venenatis. Proin non neque lacus. Curabitur venenatis tempus sem, vitae",
+    "porttitor magna fringilla vel. Cras dignissim egestas lacus nec",
+    "hendrerit. Proin pharetra, felis ac auctor dapibus, neque orci commodo ",
+    "lorem, sit amet posuere erat quam euismod arcu. Nulla pharetra augue at",
+    "enim tempus faucibus. Sed dictum tristique nisl sed rhoncus. Etiam ",
+    "tristique nisl eget risus blandit iaculis. Lorem ipsum dolor sit amet,",
+    "consectetur adipiscing elit."].join("");
+
+/**
+ * Helper function to turn the string from getComputedStyle to int
+ *
+ */
+function clean_size(val) {
+    return parseInt(val.replace('px', ''), 10);
+}
+
+/**
+ * Helper to extract the computed height of the element
+ *
+ */
+function get_height(target) {
+    return clean_size(target.getComputedStyle('height'));
+}
+
+/**
+ * In order to update the content we need to change the text, but also to fire
+ * the event that the content has changed since we're modifying it
+ * programatically
+ *
+ */
+function update_content(target, val) {
+    target.set('value', val);
+
+    // instead of hitting the changed event directly, we'll just manually call
+    // into the hook for the event itself
+    target.resizing_textarea._run_change(val);
+}
+
+var suite = new Y.Test.Suite("Resizing Textarea Tests");
+
+suite.add(new Y.Test.Case({
+
+    name: 'resizing_textarea',
+
+    test_initial_resizable: function() {
+        var target = Y.one('#init');
+
+        Y.Assert.areEqual('Initial text', target.get('value'));
+
+        target.plug(Y.lp.app.formwidgets.ResizingTextarea, {
+            skip_animations: true
+        });
+
+        // get the current sizes so we can pump text into it and make sure it
+        // grows
+        var orig_height = get_height(target);
+        update_content(target, test_text);
+
+        var new_height = get_height(target);
+        Y.Assert.isTrue(new_height > orig_height,
+            "The height should increase with content");
+
+    },
+
+    test_max_height: function () {
+        var target = Y.one('#with_defaults');
+
+        target.plug(Y.lp.app.formwidgets.ResizingTextarea, {
+            skip_animations: true,
+            max_height: 200,
+            min_height: 100
+        });
+
+        var min_height = get_height(target);
+        Y.Assert.areSame(100, min_height,
+            "The height should be no smaller than 100px");
+
+        update_content(target, test_text);
+
+        var new_height = get_height(target);
+        Y.Assert.areSame(200, new_height,
+            "The height should only get to 200px");
+    },
+
+    test_removing_content: function () {
+        var target = Y.one('#shrinkage');
+
+        target.plug(Y.lp.app.formwidgets.ResizingTextarea, {
+            skip_animations: true,
+            min_height: 100
+        });
+
+        update_content(target, test_text);
+        var max_height = get_height(target);
+        Y.Assert.isTrue(max_height > 100,
+            "The height should be larger than our min with content");
+
+        update_content(target, "shrink");
+
+        var min_height = get_height(target);
+        Y.Assert.areSame(100, min_height,
+            "The height should shrink back to our min");
+    },
+
+    test_multiple: function () {
+        var target = Y.all('.test_multiple');
+
+        target.plug(Y.lp.app.formwidgets.ResizingTextarea, {
+            skip_animations: true,
+            min_height: 100
+        });
+
+        target.each(function (node) {
+            var min_height = get_height(node);
+            Y.Assert.areSame(100, min_height,
+                "The height of the node should be 100");
+        });
+
+        // now set the content in the first one and check it's unique
+        update_content(Y.one('.first'), test_text);
+
+        var first = Y.one('.first');
+        var second = Y.one('.second');
+
+        var first_height = get_height(first);
+        Y.Assert.isTrue(first_height > 100,
+            "The height of the first should now be > 100");
+
+        var second_height = get_height(second);
+        Y.Assert.areSame(100, second_height,
+            "The height of the second should still be 100");
+    },
+
+    test_css_height_preset: function () {
+        var target = Y.one('#css_height');
+
+        target.plug(Y.lp.app.formwidgets.ResizingTextarea, {
+            skip_animations: true
+        });
+
+        var current_height = get_height(target);
+        Y.Assert.areSame(120, current_height,
+            "The height should match the css property at 120px");
+    }
+}));
+
+var yconsole = new Y.Console({
+    newestOnTop: false
+});
+yconsole.render('#log');
+
+Y.on('load', function (e) {
+    Y.lp.testing.Runner.run(suite);
+});
+
+});

=== modified file 'lib/lp/bugs/javascript/filebug_dupefinder.js'
--- lib/lp/bugs/javascript/filebug_dupefinder.js	2011-07-18 15:07:40 +0000
+++ lib/lp/bugs/javascript/filebug_dupefinder.js	2011-11-24 03:57:28 +0000
@@ -197,6 +197,17 @@
             show_bug_reporting_form();
         }
 
+        // now we need to wire up the text expander after we load our textarea
+        // onto the page, but only if we find one on the page. In testing we
+        // don't have one. We want to just fail silently.
+        var textarea = Y.one("#bug-reporting-form textarea");
+        if (textarea) {
+            textarea.plug(
+                Y.lp.app.formwidgets.ResizingTextarea, {
+                min_height: 300
+            });
+        }
+
         // Copy the value from the search field into the title field
         // on the filebug form.
         Y.one('#bug-reporting-form input[name=field.title]').set(
@@ -346,6 +357,7 @@
         // confuse the view when we submit a bug report.
         search_field.set('name', 'field.search');
         search_field.set('id', 'field.search');
+
         // Set up the handler for the search form.
         var search_form = Y.one('#filebug-search-form');
         search_form.on('submit', function(e) {
@@ -487,4 +499,5 @@
 
 }, "0.1", {"requires": [
     "base", "io", "oop", "node", "event", "json", "lazr.formoverlay",
-    "lazr.effects", "lp.app.widgets.expander"]});
+    "lazr.effects", "lp.app.widgets.expander",
+    "lp.app.formwidgets.resizing_textarea", "plugin"]});

=== modified file 'lib/lp/bugs/javascript/tests/test_filebug_dupfinder.html'
--- lib/lp/bugs/javascript/tests/test_filebug_dupfinder.html	2011-07-08 06:06:15 +0000
+++ lib/lp/bugs/javascript/tests/test_filebug_dupfinder.html	2011-11-24 03:57:28 +0000
@@ -18,6 +18,7 @@
     <!-- Some required dependencies -->
     <script type="text/javascript" src="../../../app/javascript/effects/effects.js"></script>
     <script type="text/javascript" src="../../../app/javascript/overlay/overlay.js"></script>
+    <script type="text/javascript" src="../../../app/javascript/formwidgets/resizing_textarea.js"></script>
 
     <!-- The module under test -->
     <script type="text/javascript"