Merge lp:~rockstar/phazr/string-constants into lp:phazr

[Paul Hummer]

Consolidate duplicate strings for better compressability.

So this evening I wrote this little tool[1] to detect duplicate strings in javascript files. Ideally, our compressor would detect these and figure it out for us, but that's the future, not the present. I used this tool on the phazr files to see where we might have duplicate strings, and then made "constants" out of them. It's a trivial thing, but something I think is still beneficial, at least until our compressor does it.

[1] https://github.com/rockstar/node-skillet

[Deryck Hodge (deryck)]

Looks good. Cool idea for a little tool, too.

review: Approve (code)

=== modified file 'src/editableplugin/js/editable.js'
--- src/editableplugin/js/editable.js	2011-08-24 21:17:37 +0000
+++ src/editableplugin/js/editable.js	2011-09-08 05:07:08 +0000
@@ -1,26 +1,35 @@
-Y.Editable = Y.Base.create('editable', Y.Plugin.Base, [], {
+var CLICK = 'click',
+    EDITABLE = 'editable',
+    EDITOR = 'editor',
+    EMPTYDIV = '<div></div>',
+    FIRSTCHILD = 'firstChild',
+    HOST = 'host',
+    MULTILINE = 'multiline',
+    VALUE = 'value';
+
+Y.Editable = Y.Base.create(EDITABLE, Y.Plugin.Base, [], {
     initializer: function(config) {
-        var host = this.get('host');
-        host.addClass('editable');
-        host.on('click', Y.bind(this.edit, this));
+        var host = this.get(HOST);
+        host.addClass(EDITABLE);
+        host.on(CLICK, Y.bind(this.edit, this));
     },
     cancel: function() {
-        var editor = this.get('editor'),
-            host = this.get('host');
+        var editor = this.get(EDITOR),
+            host = this.get(HOST);
         editor.hide();
         host.show();
     },
     edit: function(e) {
         e.preventDefault();
-        var host = this.get('host');
-            multiline = this.get('multiline'),
+        var host = this.get(HOST);
+            multiline = this.get(MULTILINE),
             text = Y.Lang.trim(host.get('text')),
-            editor = this.get('editor');
+            editor = this.get(EDITOR);
 
         if (editor === null) {
             var parentNode = host.get('parentNode'),
-                editor = Y.Node.create('<div></div>'),
-                controlTemplate = multiline ? '<div></div>' : '<span></span>',
+                editor = Y.Node.create(EMPTYDIV),
+                controlTemplate = multiline ? EMPTYDIV : '<span></span>',
                 controls = Y.Node.create(controlTemplate),
                 save = Y.Node.create(this.get('saveTemplate')),
                 cancel = Y.Node.create(this.get('cancelTemplate')),
@@ -32,8 +41,8 @@
                 textbox = Y.Node.create('<input type="text" />');
             }
 
-            save.on('click', this.save, this);
-            cancel.on('click', this.cancel, this);
+            save.on(CLICK, this.save, this);
+            cancel.on(CLICK, this.cancel, this);
 
             controls.appendChild(save);
             controls.appendChild(cancel);
@@ -43,18 +52,18 @@
 
             textbox.on('keyup', this._handleKeyPress, this);
             parentNode.insert(editor, host);
-            this.set('editor', editor);
+            this.set(EDITOR, editor);
         }
 
-        editor.get('firstChild').set('value', text);
+        editor.get(FIRSTCHILD).set(VALUE, text);
         editor.show();
         host.hide();
     },
     save: function() {
-        var editor = this.get('editor'),
-            host = this.get('host'),
+        var editor = this.get(EDITOR),
+            host = this.get(HOST),
             save = this.get('saveFn'),
-            value = editor.get('firstChild').get('value');
+            value = editor.get(FIRSTCHILD).get(VALUE);
         if (save !== null) { save(value); }
         host.setContent(value);
         editor.hide();
@@ -63,7 +72,7 @@
     _handleKeyPress: function(e) {
         if (e.keyCode) {
             if (e.keyCode === 27) { this.cancel(); }
-            if (e.keyCode === 13 && this.get('multiline') === false) {
+            if (e.keyCode === 13 && this.get(MULTILINE) === false) {
                 this.save();
             }
         }
@@ -76,5 +85,5 @@
         saveFn: { value: null },
         saveTemplate: { value: '<button class="phazr-button phazr-save">Save</button>' }
     },
-    NS: 'editable'
+    NS: EDITABLE
 });

=== modified file 'src/formplugin/js/form.js'
--- src/formplugin/js/form.js	2011-08-24 21:00:55 +0000
+++ src/formplugin/js/form.js	2011-09-08 05:07:08 +0000
@@ -1,18 +1,25 @@
+var CANCELBUTTON = 'cancelButton',
+    CLICK = 'click',
+    FORM = 'form',
+    HOST = 'host',
+    SAVEBUTTON = 'saveButton',
+    SUBMITFN = 'submitFn';
+
 Y.FormPlugin = Y.Base.create('formplugin', Y.Plugin.Base, [], {
     initializer: function(config) {
-        var host = this.get('host');
+        var host = this.get(HOST);
 
         if (config.submitFn) {
-            this.set('submitFn', config.submitFn);
+            this.set(SUBMITFN, config.submitFn);
         }
 
         this.afterHostMethod('renderUI', this.renderUI);
         this.afterHostMethod('bindUI', this.bindUI);
     },
     renderUI: function() {
-        var host = this.get('host'),
-            saveButton = this.get('saveButton'),
-            cancelButton = this.get('cancelButton'),
+        var host = this.get(HOST),
+            saveButton = this.get(SAVEBUTTON),
+            cancelButton = this.get(CANCELBUTTON),
             controls = Y.Node.create('<div></div>');
         controls.addClass(host.getClassName() + '-controls');
         controls.appendChild(saveButton);
@@ -20,23 +27,23 @@
         host.get('contentBox').appendChild(controls);
     },
     bindUI: function() {
-        var host = this.get('host');
+        var host = this.get(HOST);
             footer = host.get('boundingBox').one('.yui3-widget-ft');
-        this.get('saveButton').on('click', this.get('submitFn'), this.get('host'));
-        this.get('cancelButton').on('click', this.close, this);
+        this.get(SAVEBUTTON).on(CLICK, this.get(SUBMITFN), this.get(HOST));
+        this.get(CANCELBUTTON).on(CLICK, this.close, this);
     },
     close: function(e) {
         e.preventDefault();
-        this.get('host').hide();
+        this.get(HOST).hide();
     },
     loadForm: function(form) {
-        var host = this.get('host'),
+        var host = this.get(HOST),
             form_node = Y.Node.create(form);
         host.set('bodyContent', form_node);
-        this.set('form', form_node);
+        this.set(FORM, form_node);
     },
     loadFormFromURL: function(url) {
-        var host = this.get('host');
+        var host = this.get(HOST);
         Y.io(url, {
             on: {
                 success: function(id, response) {
@@ -70,5 +77,5 @@
             }
         }
     },
-    NS: 'form'
+    NS: FORM
 });

=== modified file 'src/phazroverlay/js/overlay.js'
--- src/phazroverlay/js/overlay.js	2011-08-25 03:24:53 +0000
+++ src/phazroverlay/js/overlay.js	2011-09-08 05:07:08 +0000
@@ -1,3 +1,10 @@
+var BOUNDINGBOX = 'boundingBox',
+    CLOSEBUTTON = 'closeButton',
+    CLOSEBUTTONSUFFIX = '-close-button',
+    HTML = 'html',
+    MODALOUTSIDECLICK = 'modaloutside|click',
+    PERIOD = '.';
+
 var ModalOverlay = function(config) {
     Y.Do.after(this.afterRenderUI, this, 'renderUI');
     Y.Do.after(this.afterBindUI, this, 'bindUI');
@@ -12,27 +19,27 @@
             className = this.getClassName(),
             context = {
                 containerClassName: className + '-close',
-                linkClassName: className + '-close-button'
+                linkClassName: className + CLOSEBUTTONSUFFIX
             },
             closeContainer = Y.Node.create(
                 Y.substitute(template, context));
         this.get('contentBox').prepend(closeContainer);
-        this.set('closeButton',
-            closeContainer.one('.' + className + '-close-button'));
+        this.set(CLOSEBUTTON,
+            closeContainer.one(PERIOD + className + CLOSEBUTTONSUFFIX));
     },
     afterBindUI: function() {
         this.after('renderedChange', this.afterRenderedChange, this);
         this.after('visibleChange', this.afterVisibleChange, this);
-        this.get('closeButton').on('click', this.hide, this);
+        this.get(CLOSEBUTTON).on('click', this.hide, this);
         Y.on('keyup', function(e) {
             if (e.keyCode == 27) {
                 this.hide();
             }
         }, window, this);
 
-        var box = this.get('boundingBox'),
+        var box = this.get(BOUNDINGBOX),
             className = this.getClassName(),
-            header = box.one('.' + className + '-hd'),
+            header = box.one(PERIOD + className + '-hd'),
             dd = new Y.DD.Drag({
                 node: box,
                 handle: header
@@ -53,19 +60,19 @@
         }
     },
     attachModalOutside: function() {
-        var box = this.get('boundingBox');
-        Y.one("html").on("modaloutside|click",
+        var box = this.get(BOUNDINGBOX);
+        Y.one(HTML).on(MODALOUTSIDECLICK,
             function(e) {
                 var targ = e.target;
                 if (!box.contains(targ)) {
                     this.hide();
-                    Y.detach("modaloutside|click");
+                    Y.detach(MODALOUTSIDECLICK);
                 }
             },
         this);
     },
     detachModalOutside: function() {
-        Y.one("html").detach("modaloutside|click");
+        Y.one(HTML).detach(MODALOUTSIDECLICK);
     }
 };