whowish_word 0.1.6 → 0.1.7

data/README.md

@@ -1,15 +1,27 @@
-WhowishWord - A wording framework for Rails
+WhowishWord - a Rails gem that make static content editable
 ====================
 
-Have you ever been bored when a project manager (or marketing department) keeps changing wording on a website?
-This kind of tasks can make programmers go crazy.
+WhowishWord makes static content editable, as long as the programmers follow its convention.
 
-WhowishWord allows normal users to change wording on a Rails website, directly.
+
+The problem WhowishWord tries to solve
+---------------------------------------
+
+The problem that I personally faced in my company, Whowish, is that:
+
+	Occasionally CEO or VP of Marketing would send me an email to change the word 'Save'(on a submit button) to the word 'Post'.
+	I would have to go to the source code and change it.
+	And when this happens too often, it drives us, the programmers, crazy
+
+WhowishWord tries to solve this problem elegantly. It is much better than using a config file.
+
+It gives a simple tool for CEO, VP of Marketing (or whoever it is) to make changes themselves.
 
 The beauty of WhowishWord is that:
 
 * It is almost transparent to programmers
 * Programmers don't have to care how wording should be. This makes them work much faster
+* It does not clutter up your source code because you replace one static content unit with one function call
 
 
 How you should work
@@ -151,7 +163,7 @@ Tanin Na Nakorn
 Tanun Niyomjit (Designer)
 
 
-Boring license stuffs
+Boring legal stuff
 -----------------------
 
 WhowishWord relies on several libraries that you won't see.

data/lib/whowish_word/rails/public/javascripts/0_class.js

@@ -1,64 +1,64 @@
-/* Simple JavaScript Inheritance
- * By John Resig http://ejohn.org/
- * MIT Licensed.
- */
-// Inspired by base2 and Prototype
-(function(){
-  var initializing = false, fnTest = /xyz/.test(function(){xyz;}) ? /\b_super\b/ : /.*/;
-
-  // The base Class implementation (does nothing)
-  this.Class = function(){};
- 
-  // Create a new Class that inherits from this class
-  Class.extend = function(prop) {
-    var _super = this.prototype;
-   
-    // Instantiate a base class (but only create the instance,
-    // don't run the init constructor)
-    initializing = true;
-    var prototype = new this();
-    initializing = false;
-   
-    // Copy the properties over onto the new prototype
-    for (var name in prop) {
-      // Check if we're overwriting an existing function
-      prototype[name] = typeof prop[name] == "function" &&
-        typeof _super[name] == "function" && fnTest.test(prop[name]) ?
-        (function(name, fn){
-          return function() {
-            var tmp = this._super;
-           
-            // Add a new ._super() method that is the same method
-            // but on the super-class
-            this._super = _super[name];
-           
-            // The method only need to be bound temporarily, so we
-            // remove it when we're done executing
-            var ret = fn.apply(this, arguments);       
-            this._super = tmp;
-           
-            return ret;
-          };
-        })(name, prop[name]) :
-        prop[name];
-    }
-   
-    // The dummy class constructor
-    function Class() {
-      // All construction is actually done in the init method
-      if ( !initializing && this.init )
-        this.init.apply(this, arguments);
-    }
-   
-    // Populate our constructed prototype object
-    Class.prototype = prototype;
-   
-    // Enforce the constructor to be what we expect
-    Class.prototype.constructor = Class;
-
-    // And make this class extendable
-    Class.extend = arguments.callee;
-   
-    return Class;
-  };
-})();
+/* Simple JavaScript Inheritance
+ * By John Resig http://ejohn.org/
+ * MIT Licensed.
+ */
+// Inspired by base2 and Prototype
+(function(){
+  var initializing = false, fnTest = /xyz/.test(function(){xyz;}) ? /\b_super\b/ : /.*/;
+
+  // The base Class implementation (does nothing)
+  this.Class = function(){};
+ 
+  // Create a new Class that inherits from this class
+  Class.extend = function(prop) {
+    var _super = this.prototype;
+   
+    // Instantiate a base class (but only create the instance,
+    // don't run the init constructor)
+    initializing = true;
+    var prototype = new this();
+    initializing = false;
+   
+    // Copy the properties over onto the new prototype
+    for (var name in prop) {
+      // Check if we're overwriting an existing function
+      prototype[name] = typeof prop[name] == "function" &&
+        typeof _super[name] == "function" && fnTest.test(prop[name]) ?
+        (function(name, fn){
+          return function() {
+            var tmp = this._super;
+           
+            // Add a new ._super() method that is the same method
+            // but on the super-class
+            this._super = _super[name];
+           
+            // The method only need to be bound temporarily, so we
+            // remove it when we're done executing
+            var ret = fn.apply(this, arguments);       
+            this._super = tmp;
+           
+            return ret;
+          };
+        })(name, prop[name]) :
+        prop[name];
+    }
+   
+    // The dummy class constructor
+    function Class() {
+      // All construction is actually done in the init method
+      if ( !initializing && this.init )
+        this.init.apply(this, arguments);
+    }
+   
+    // Populate our constructed prototype object
+    Class.prototype = prototype;
+   
+    // Enforce the constructor to be what we expect
+    Class.prototype.constructor = Class;
+
+    // And make this class extendable
+    Class.extend = arguments.callee;
+   
+    return Class;
+  };
+})();

data/lib/whowish_word/rails/public/javascripts/1_jquery.escape.js

@@ -1,23 +1,23 @@
-// jquery.escape 1.0 - escape strings for use in jQuery selectors
-// http://ianloic.com/tag/jquery.escape
-// Copyright 2009 Ian McKellar <http://ian.mckellar.org/>
-// Just like jQuery you can use it under either the MIT license or the GPL
-// (see: http://docs.jquery.com/License)
-
-(function($w){
-
- 	$w.extend({ 
- 		
- 		escape: function(s) {
-			escape_re = /[#;&,\.\+\*~':"!\^\$\[\]\(\)=>|\/\\]/;
-			
-			var left = s.split(escape_re, 1)[0];
-			if (left == s) return s;
-			return left + '\\' + 
-					s.substr(left.length, 1) + 
-					jQueryWhowishWord.escape(s.substr(left.length+1));
-		}
-	});
-	
-})(jQueryWhowishWord);
-
+// jquery.escape 1.0 - escape strings for use in jQuery selectors
+// http://ianloic.com/tag/jquery.escape
+// Copyright 2009 Ian McKellar <http://ian.mckellar.org/>
+// Just like jQuery you can use it under either the MIT license or the GPL
+// (see: http://docs.jquery.com/License)
+
+(function($w){
+
+ 	$w.extend({ 
+ 		
+ 		escape: function(s) {
+			escape_re = /[#;&,\.\+\*~':"!\^\$\[\]\(\)=>|\/\\]/;
+			
+			var left = s.split(escape_re, 1)[0];
+			if (left == s) return s;
+			return left + '\\' + 
+					s.substr(left.length, 1) + 
+					jQueryWhowishWord.escape(s.substr(left.length+1));
+		}
+	});
+	
+})(jQueryWhowishWord);
+

data/lib/whowish_word/rails/public/javascripts/1_jquery.sizes.min.js

@@ -1,8 +1,8 @@
-/*
- * JSizes - JQuery plugin v0.33
- *
- * Licensed under the revised BSD License.
- * Copyright 2008-2010 Bram Stein
- * All rights reserved.
- */
+/*
+ * JSizes - JQuery plugin v0.33
+ *
+ * Licensed under the revised BSD License.
+ * Copyright 2008-2010 Bram Stein
+ * All rights reserved.
+ */
 (function(b){var a=function(c){return parseInt(c,10)||0};b.each(["min","max"],function(d,c){b.fn[c+"Size"]=function(g){var f,e;if(g){if(g.width!==undefined){this.css(c+"-width",g.width)}if(g.height!==undefined){this.css(c+"-height",g.height)}return this}else{f=this.css(c+"-width");e=this.css(c+"-height");return{width:(c==="max"&&(f===undefined||f==="none"||a(f)===-1)&&Number.MAX_VALUE)||a(f),height:(c==="max"&&(e===undefined||e==="none"||a(e)===-1)&&Number.MAX_VALUE)||a(e)}}}});b.fn.isVisible=function(){return this.is(":visible")};b.each(["border","margin","padding"],function(d,c){b.fn[c]=function(e){if(e){if(e.top!==undefined){this.css(c+"-top"+(c==="border"?"-width":""),e.top)}if(e.bottom!==undefined){this.css(c+"-bottom"+(c==="border"?"-width":""),e.bottom)}if(e.left!==undefined){this.css(c+"-left"+(c==="border"?"-width":""),e.left)}if(e.right!==undefined){this.css(c+"-right"+(c==="border"?"-width":""),e.right)}return this}else{return{top:a(this.css(c+"-top"+(c==="border"?"-width":""))),bottom:a(this.css(c+"-bottom"+(c==="border"?"-width":""))),left:a(this.css(c+"-left"+(c==="border"?"-width":""))),right:a(this.css(c+"-right"+(c==="border"?"-width":"")))}}}})})(jQueryWhowishWord);

data/lib/whowish_word/rails/public/javascripts/2_whowish_word_variables.js

@@ -15,57 +15,19 @@ whowishWordVariables.whowishWordIdPattern = new RegExp("([^\|]+)(\|(.*))?");
 	
 whowishWordVariables.matchers = [
 									{
-										match: function(element) {
-											
-											for (var i = 0; i < element.attributes.length; i++) {
-												
-												if (element.attributes[i].name.toLowerCase() == "id") continue;
-												if (element.attributes[i].name.toLowerCase() == "value") continue;
-												
-												var value = element.attributes[i].value;
-												
-												if (typeof(value).toLowerCase() != "string") continue;
-												
-												if (value.match(whowishWordVariables.attributeValuePattern) != null) {
-													
-													return true;
-												}
-											}
-											
-											return false;
-										},
+										match: function(element){ return WhowishWordElementGuard.check(element); },
 										createWhowishWord: function(element) { new WhowishWordElementCreator(element); }
 									},
 									{
-										match: function(element) {
-											
-											return (element.tagName.toLowerCase() == "dfn"
-													|| element.tagName.toLowerCase() == "button"
-													|| element.tagName.toLowerCase() == "label")
-													&& (typeof(html = $w(element).html())).toLowerCase() == "string"
-													&& html.match(whowishWordVariables.attributeValuePattern) != null;
-													
-										},
+										match: function(element) { return WhowishWordHtmlGuard.check(element); },
 										createWhowishWord: function(element) { new WhowishWordHtmlCreator(element); }
 									},
 									{
-										match: function(element) {
-											
-											return element.tagName.toLowerCase() != "select"
-													&& (typeof(val = $w(element).val())).toLowerCase() == "string"
-													&& val.match(whowishWordVariables.attributeValuePattern) != null;
-													
-										},
+										match: function(element) { return WhowishWordValueGuardAndSanitizer.check(element); },
 										createWhowishWord: function(element) { new WhowishWordValueCreator(element); }
 									},
 									{
-										match: function(element) {
-											
-											return element.tagName.toLowerCase() == "option" 
-													&& (typeof(text = $w(element).text())).toLowerCase() == "string"
-													&& text.match(whowishWordVariables.attributeValuePattern) != null;
-													
-										},
+										match: function(element) { return WhowishWordTextGuard.check(element); },
 										createWhowishWord: function(element) { new WhowishWordTextCreator(element); }
 									}
 								];

data/lib/whowish_word/rails/public/javascripts/3_whowish_word_helper.js

@@ -3,7 +3,25 @@
  */
 var whowishWordHelper = {};
 
-function log(msg) {
+whowishWordHelper.sanitize = function(content) {
+	return content.replace(whowishWordVariables.attributeValuePattern,"$2")
+}
+
+whowishWordHelper.match = function(content) {
+	return whowishWordHelper.matchWithResult(content) != null;
+}
+
+whowishWordHelper.matchWithResult = function(content) {
+	return content.match(whowishWordVariables.attributeValuePattern);
+}
+
+whowishWordHelper.makeEditIconId = function(element, name) {
+	return element.id + 
+			whowishWordVariables.separator + 
+			name;
+}
+
+whowishWordHelper.log = function(msg) {
 	try {
 		console.log(msg);
 	} catch (e) {}
@@ -13,7 +31,7 @@ whowishWordHelper.repositionAllEditIconPanels = function() {
 	
 	var editIconPanels = $w('.whowishWordEditIconPanel');
 	for (var i=0;i<editIconPanels.length;i++) {
-		editIconPanels[i].whowishWord.reposition();
+		whowishWordStorage[editIconPanels[i].id].reposition();
 	}
 	
 };
@@ -39,13 +57,14 @@ whowishWordHelper.editHandler = function(event) {
 	event.preventDefault() 
 
 	var self = this;
+	var customData = whowishWordStorage[this.id]
 
 	$w.whowishWordDialog.open({
 		
-		whowishWordId: this.whowishWord.id,
-		variables: this.whowishWord.variables,
-		attributeName: this.whowishWord.attributeName,
-		content: this.whowishWord.contentHandler.getContent(),
+		whowishWordId: customData.id,
+		variables: customData.variables,
+		attributeName: customData.attributeName,
+		content: customData.contentHandler.getContent(),
 		success: function(html){
 			
 			$w.whowishWordDialog.start_loading();
@@ -58,11 +77,11 @@ whowishWordHelper.editHandler = function(event) {
 					"Connection": "close"
 				},
 				data: {
-					"word_id": self.whowishWord.id,
+					"word_id": customData.id,
 					"content": html
 				},
 				success: function(data) {
-					self.whowishWord.contentHandler.setContent(html);
+					customData.contentHandler.setContent(html);
 					$w.whowishWordDialog.close();
 					$w.whowishWordDialog.stop_loading();
 				},
@@ -79,7 +98,7 @@ whowishWordHelper.editHandler = function(event) {
 
 	
 whowishWordHelper.extractWhowishWordIdFromText = function(text) {
-	var result = text.match(whowishWordVariables.attributeValuePattern);
+	var result = whowishWordHelper.matchWithResult(text);
 	return result[1];
 	
 };

data/lib/whowish_word/rails/public/javascripts/4_whowish_word.js

@@ -1,43 +1,45 @@
-/**
- * @author Tanin Na Nakorn
- */
-
-(function($w){
-
- 	$w.extend({ 
- 		
- 		whowishWord: function(recurring) {
-			
-			var elems = $w('body').find('*');
-			var matchers = whowishWordVariables.matchers;
-			
-			for (var i=0;i<elems.length;i++) {
-				
-				for (var j=0;j<matchers.length;j++) {
-					
-					if (matchers[j].match(elems[i])) {
-					
-						if (elems[i].id == "" || elems[i].id == undefined) {
-							elems[i].id = "whowishWordId" + (whowishWordVariables.idRunner++);
-						}
-						
-						matchers[j].createWhowishWord(elems[i]);
-					}
-				}
-				
-			}
-			
-			$w('.whowishWordEditIcon').die('click');
-			whowishWordHelper.repositionAllEditIconPanels();
-			$w('.whowishWordEditIcon').live('click', whowishWordHelper.editHandler);
-			
-			if (recurring != false) {
-				setTimeout("$w.whowishWord(true);",1000);
-			}
-			
-		}
-		
-	});
-	
-})(jQueryWhowishWord);
-
+/**
+ * @author Tanin Na Nakorn
+ */
+
+var whowishWordStorage = {};
+
+(function($w){
+
+ 	$w.extend({ 
+ 		
+ 		whowishWord: function(recurring) {
+			
+			var elems = $w('body').find('*');
+			var matchers = whowishWordVariables.matchers;
+			
+			for (var i=0;i<elems.length;i++) {
+				
+				for (var j=0;j<matchers.length;j++) {
+					
+					if (matchers[j].match(elems[i])) {
+					
+						if (elems[i].id == "" || elems[i].id == undefined) {
+							elems[i].id = "whowishWordId" + (whowishWordVariables.idRunner++);
+						}
+						
+						matchers[j].createWhowishWord(elems[i]);
+					}
+				}
+				
+			}
+			
+			$w('.whowishWordEditIcon').die('click');
+			whowishWordHelper.repositionAllEditIconPanels();
+			$w('.whowishWordEditIcon').live('click', whowishWordHelper.editHandler);
+			
+			if (recurring != false) {
+				setTimeout("$w.whowishWord(true);",1000);
+			}
+			
+		}
+		
+	});
+	
+})(jQueryWhowishWord);
+

data/lib/whowish_word/rails/public/javascripts/4_whowish_word_content_handler.js

@@ -1,15 +1,15 @@
-var WhowishWordContentHandler = Class.extend({
-	
-  init: function(elem){
-    this.element = elem;
-  },
-  
-  setContent: function(){
-    throw 'Not implemented';
-  },
-  
-  getContent: function(){
-    throw 'Not implemented';
-  }
-  
-});
+var WhowishWordContentHandler = Class.extend({
+	
+  init: function(elem){
+    this.element = elem;
+  },
+  
+  setContent: function(){
+    throw 'Not implemented';
+  },
+  
+  getContent: function(){
+    throw 'Not implemented';
+  }
+  
+});

data/lib/whowish_word/rails/public/javascripts/4_whowish_word_creator.js

@@ -37,15 +37,19 @@ var WhowishWordCreator = Class.extend({
   	
 	var editIconPanel = document.createElement('span');
 	
-	editIconPanel.whowishWord = {};
-	editIconPanel.whowishWord.editIconPanel = editIconPanel;
-	editIconPanel.whowishWord.element = this.element;
-	editIconPanel.whowishWord.reposition = whowishWordHelper.editIconPanelRepositioning;
-	
 	$w(editIconPanel).attr('id', this.generateEditIconPanelId())
 					.addClass('whowishWordEditIconPanel');
+	
+	customData = {};
+	customData.editIconPanel = editIconPanel;
+	customData.element = this.element;
+	customData.reposition = whowishWordHelper.editIconPanelRepositioning;
+	
+	whowishWordStorage[editIconPanel.id] = customData;
+	
+	
 					
-	editIconPanel.whowishWord.reposition();
+	whowishWordStorage[editIconPanel.id].reposition();
 					
 					
 	$w(this.element).after(editIconPanel);

data/lib/whowish_word/rails/public/javascripts/5_whowish_word_common_creator.js

@@ -1,49 +1,51 @@
-var WhowishWordCommonCreator = WhowishWordCreator.extend({
-	
-	identity: function() {
-		throw 'identity() is not implemented'
-	},
-	
-	getContent: function() {
-		throw 'getContent() is not implemented'
-	},
-	
-	setContent: function() {
-		throw 'setContent() is not implemented'
-	},
-	
-	instantiateAndGetContentHandler: function() {
-		throw 'instantiateAndGetContentHandler() is not implemented'
-	},
-	
-	makeEditIcon: function(){
-		
-		var editIcon = document.createElement('span');
-		$w(editIcon).addClass('whowishWordEditIcon');
-		$w(editIcon).attr('id', this.element.id + 
-								whowishWordVariables.separator + 
-								this.identity());
-		$w(editIcon).attr('title', this.identity());
-		
-		var whowishWordIdPackage = whowishWordHelper.extractWhowishWordIdFromText(this.getContent());
-		var idPackage = whowishWordHelper.parseWhowishWordIdPackage(whowishWordIdPackage);
-		
-		editIcon.whowishWord = {};
-		editIcon.whowishWord.contentHandler = this.instantiateAndGetContentHandler();
-		
-		editIcon.whowishWord.id = idPackage.id;
-		editIcon.whowishWord.variables = idPackage.variables;
-		
-		this.addEditIcon(editIcon);
-
-	},
-  
-  
-	sanitize: function(){
-
-		this.setContent(this.getContent().replace(whowishWordVariables.attributeValuePattern,"$2"));
-	
-	},
-
-  
+var WhowishWordCommonCreator = WhowishWordCreator.extend({
+	
+	identity: function() {
+		throw 'identity() is not implemented'
+	},
+	
+	getContent: function() {
+		throw 'getContent() is not implemented'
+	},
+	
+	setContent: function() {
+		throw 'setContent() is not implemented'
+	},
+	
+	instantiateAndGetContentHandler: function() {
+		throw 'instantiateAndGetContentHandler() is not implemented'
+	},
+	
+	makeEditIcon: function(){
+		
+		var editIcon = document.createElement('span');
+		$w(editIcon).addClass('whowishWordEditIcon');
+		$w(editIcon).attr('id', this.element.id + 
+								whowishWordVariables.separator + 
+								this.identity());
+		$w(editIcon).attr('title', this.identity());
+		
+		var whowishWordIdPackage = whowishWordHelper.extractWhowishWordIdFromText(this.getContent());
+		var idPackage = whowishWordHelper.parseWhowishWordIdPackage(whowishWordIdPackage);
+		
+		customData = {};
+		customData.contentHandler = this.instantiateAndGetContentHandler();
+		
+		customData.id = idPackage.id;
+		customData.variables = idPackage.variables;
+		
+		whowishWordStorage[editIcon.id] = customData;
+		
+		this.addEditIcon(editIcon);
+
+	},
+  
+  
+	sanitize: function(){
+
+		this.setContent(whowishWordHelper.sanitize(this.getContent()));
+	
+	},
+
+  
 });