mizugumo 0.1.1 → 0.1.3

data/README.rdoc

@@ -3,8 +3,7 @@
 Mizugumo is a gem designed to provide Rails with JavaScript and AJAX behavior that is:
 * absolutely seamless
 * completely unobtrusive - no markup whatsoever in your HTML and
-* gracefully-degrading: defaults to fully functional and
-sensible page-reload behavior when javascript is not available.
+* gracefully-degrading: defaults to fully functional and sensible page-reload behavior when JavaScript is not available.
 
 See a demo running at:
   http://mizugumo-demo.lrdesign.com
@@ -16,18 +15,21 @@ Mizugumo uses NinjaScript by Judson Lester to provide unobtrusive JS behaviors.
 
 == WARNINGS
 
-In the current (early release) version, Mizugumo and NinjaScript have some limitations.   Notably, in this version they will clobber the normal rails.js and prevent its behaviors from
+In the current (early release) version, Mizugumo and NinjaScript have some limitations.
+Notably, in this version they will clobber the normal rails.js and prevent its behaviors from
 working.  The installer will copy a jQuery-compatible version of rails.js that you should
-use instead if you depend on Rails' default (semi-obtrusive) approaches to AJAX, link_to with :confirm =>'Are you sure?' and similar things working.
+use instead if you depend on Rails' default (semi-obtrusive) approaches to AJAX, 
+link_to with :confirm =>'Are you sure?' and similar things working.
 
-In addition, NinjaScript currently requires jQuery 1.4.2.  It is NOT compatible with the current version of jQuery, 1.4.4, or the development version 1.5.   We are eagerly working on a fix.
+In addition, NinjaScript currently requires jQuery 1.4.2.  It is NOT compatible with the current version of jQuery, 1.5.
+We are eagerly working on a fix.
 
 == Features
 
 Mizugumo's main features are:
 * Easy tools for installing NinjaScript
-* A rails helper to automatically output <form>s instead of <a> tags when link_to is called with a :method other than GET.   This allows these links to function as intended for users who lack javascript.
-* A default NinjaScript behavior (in your application.js) that automatically converts those forms back into the expected links when Javascript is available, resulting in transparent usability for JS users.
+* A Rails helper to automatically output <form>s instead of <a> tags when link_to is called with a :method other than GET.   This allows these links to function as intended for users who lack JavaScript.
+* A default NinjaScript behavior (in your application.js) that automatically converts those forms back into the expected links when JavaScript is available, resulting in transparent usability for JS users.
 * A scaffold generator that builds both both AJAX behavior and standard "page-reload"  behavior in the controller and view and adds NinjaScript  behaviors to application.js to activate AJAX.  Out of the box, your scaffolded controller will function as an AJAX controller when JS is available but will degrade properly when JS is not available.
 
 == Installing
@@ -41,7 +43,7 @@ First, add Mizugumo to your gemfile:
 
 Second, install Mizugumo files:
 
-  > rails generate mizugumo:install
+  rails generate mizugumo:install
 
 Third, link to jQuery and NinjaScript in your application layout, plus the optional ninjascript.css.  If using ERB, add these lines:
 
@@ -66,7 +68,8 @@ side-by-side with Prototype.
 Rails' concept of REST runs headlong into the desire to make a site degrade
 gracefully.   Specifically, the link_to() helper, when passed a method other
 than 'get', outputs a link with a data-method attribute that won't work
-when JS is absent.   To wit:  link_to('Delete Item', @item, :method => 'delete') in rails outputs this:
+when JS is absent.   To wit:  link_to('Delete Item', @item, :method => 'delete') 
+in Rails outputs this:
 
    <a href='/items/1' data-method='delete'>Delete Item</a>
 
@@ -110,7 +113,8 @@ complex GET links.
 
 == Scaffold generator
 
-Mizugumo ships with a scaffold generator that builds out-of-the-box AJAX/UJS scaffolds that degrade gracefully in the absence of JavaScript.   To use it, add this to config/application.rb:
+Mizugumo ships with a scaffold generator that builds out-of-the-box AJAX/UJS scaffolds that degrade 
+gracefully in the absence of JavaScript.   To use it, add this to config/application.rb:
 
 For ERB views:
 
@@ -119,7 +123,7 @@ For ERB views:
     g.template_engine 'mizugumo:erb'
   end
 
-For HAML views:
+For Haml views:
 
   config.generators do |g|
     g.scaffold_controller 'mizugumo:scaffold_controller'
@@ -130,7 +134,6 @@ For HAML views:
 == Contributing to Mizugumo
 
 * Install MizugumoDemo and make sure that its tests still pass with your version of Mizugumo!
-
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -145,7 +148,7 @@ Use the GitHub issue tracker.
 
 == Copyright
 
-Copyright (c) 2011 Evan Dorn and Logical Reality design. See LICENSE.txt for
+Copyright (c) 2011 Evan Dorn and Logical Reality Design. See LICENSE.txt for
 further details.
 
 Web Development by Logical Reality Design: http://LRDesign.com

data/lib/generators/mizugumo/install/templates/javascripts/jquery.ninja_script.js

@@ -1,7 +1,10 @@
 /* 
- * NinjaScript - 0.8.0
- * written and copyright 2010-2011 Judson Lester and Logical Reality Design
+ * NinjaScript - 0.8.2
+ * written by and copyright 2010-2011 Judson Lester and Logical Reality Design
  * Licensed under the MIT license
+ * 2011-02-04
+ *
+ * Those new to this source should skim down to standardBehaviors
  */
 Ninja = (function() {
     function log(message) {
@@ -108,6 +111,9 @@ Ninja = (function() {
       return jQuery.extend(left, right)
     },
     ensureDefaults: function(config, defaults) {
+      if(!config instanceof Object) {
+        config = {}
+      }
       return this.enrich(defaults, config)
     },
     //DOM and Events
@@ -191,6 +197,9 @@ Ninja = (function() {
       return "GET"
     },
     //Ninjascript utils
+    cantTransform: function() {
+      throw new TransformFailedException
+    },
     applyBehaviors: function(element, behaviors) {
       this.getRootCollection().apply(element, behaviors)
     },
@@ -221,7 +230,7 @@ Ninja = (function() {
     },
     busyOverlay: function(elem) {
       var overlay = this.overlay(elem)
-      overlay.set.addClass("ninja busy")
+      overlay.set.addClass("ninja_busy")
       overlay.laziness = this.ninja.config.busyLaziness
       return overlay
     },
@@ -390,7 +399,7 @@ Ninja = (function() {
       for(var eventName in behavior.eventHandlers) {
         var oldHandler = this.handlers[eventName]
         if(typeof oldHandler == "undefined") {
-          oldHandler = function(){}
+          oldHandler = function(){return true}
         }
         this.handlers[eventName] = behavior.buildHandler(context, eventName, oldHandler)
       }
@@ -407,6 +416,7 @@ Ninja = (function() {
 
   function RootContext() {
     this.stashedElements = []
+    this.eventHandlerSet = {}
   }
 
   RootContext.prototype = Ninja.tools.enrich(
@@ -424,10 +434,16 @@ Ninja = (function() {
         var formDiv = Ninja.tools.hiddenDiv()
         forEach(this.stashedElements, function(element) {
             var elem = jQuery(element)
-            elem.data("ninja-visited", true)
+            elem.data("ninja-visited", this)
             jQuery(formDiv).append(elem)
             elem.trigger(event)
           })
+      },
+      unbindHandlers: function() {
+        var el = jQuery(this.element)
+        for(eventName in this.eventHandlerSet) {
+          el.unbind(eventName, this.eventHandlerSet[eventName])
+        }
       }
   })
 
@@ -524,10 +540,13 @@ Ninja = (function() {
       }
     },
     applyBehaviorsTo: function(element, behaviors) {
+      return this.applyBehaviorsInContext(new RootContext, element, behaviors)
+    },
+    applyBehaviorsInContext: function(context, element, behaviors) {
       var curContext, 
-      context = new RootContext, 
       applyList = [], 
       scribe = new EventScribe
+      Ninja.tools.enrich(scribe.handlers, context.eventHandlerSet)
 
       behaviors = behaviors.sort(function(left, right) {
           if(left.priority != right.priority) {
@@ -570,9 +589,10 @@ Ninja = (function() {
           }
         }
       )
-      jQuery(element).data("ninja-visited", true)
+      jQuery(element).data("ninja-visited", context)
 
       scribe.applyEventHandlers(element)
+      Ninja.tools.enrich(context.eventHandlerSet, scribe.handlers)
 
       this.fireMutationEvent()
 
@@ -598,7 +618,8 @@ Ninja = (function() {
     apply: function(element, startBehaviors, selectorIndex) {
       var applicableBehaviors = [], len = this.selectors.length
       this.collectBehaviors(element, applicableBehaviors, startBehaviors)
-      if (!jQuery(element).data("ninja-visited")) {
+      var context = jQuery(element).data('ninja-visited')
+      if (!context) {
         if(typeof selectorIndex == "undefined") {
           selectorIndex = 0
         }
@@ -607,8 +628,12 @@ Ninja = (function() {
             this.collectBehaviors(element, applicableBehaviors, this.behaviors[this.selectors[j]])
           }
         }
-      }
       this.applyBehaviorsTo(element, applicableBehaviors)
+      }
+      else {
+        context.unbindHandlers()
+        this.applyBehaviorsInContext(context, element, applicableBehaviors)
+      }
     },
     applyAll: function(root){
       var len = this.selectors.length
@@ -694,7 +719,7 @@ Ninja = (function() {
       var context = this.inContext({})
 
       elem = this.applyTransform(context, elem)
-      jQuery(elem).data("ninja-visited", true)
+      jQuery(elem).data("ninja-visited", context)
 
       this.applyEventHandlers(context, elem)
 
@@ -851,9 +876,11 @@ Ninja = (function() {
       //})
       //
       submitsAsAjaxLink: function(configs) {
-        if(!(configs instanceof Object)) {
-          configs = { busyElement: undefined }
-        }
+        configs = Ninja.tools.ensureDefaults(configs,
+          { busyElement: function(elem) {
+              return $(elem).parents('address,blockquote,body,dd,div,p,dl,dt,table,form,ol,ul,tr')[0]
+            }})
+
         return new ninja.does({
             priority: 10,
             helpers: {
@@ -890,9 +917,9 @@ Ninja = (function() {
       //})
       //
       submitsAsAjaxForm: function(configs) {
-        if(!(configs instanceof Object)) {
-          configs = { busyElement: undefined }
-        }
+        configs = Ninja.tools.ensureDefaults(configs,
+          { busyElement: undefined })
+
         return new ninja.does({
             priority: 20,
             helpers: {
@@ -929,10 +956,6 @@ Ninja = (function() {
       //  busyElement: function(elem) { jQuery("#user-notification") }
       //})
       becomesAjaxLink: function(configs) {
-        if(!(configs instanceof Object)) {
-          configs = { busyElement: undefined }
-        }
-
         configs = Ninja.tools.ensureDefaults(configs, {
             busyElement: undefined,
             retainAttributes: ["id", "class", "lang", "dir", "title", "data-.*"]
@@ -970,6 +993,7 @@ Ninja = (function() {
               } 
               else {
                 log("Couldn't find a submit input in form");
+                this.cantTransform()
               }
 
               var link = jQuery("<a rel='nofollow' href='#'>" + linkText + "</a>")
@@ -988,7 +1012,7 @@ Ninja = (function() {
 
       //Use for elements that should be transient.  For instance, the default
       //behavior of failed AJAX calls is to insert a message into a
-      //div#messages with a "flash" class.  You can use this behavior to have3A2
+      //div#messages with a "flash" class.  You can use this behavior to have
       //those disappear after a few seconds.
       //
       //Configs:
@@ -1021,6 +1045,118 @@ Ninja = (function() {
   Ninja.packageBehaviors(standardBehaviors)
 })();
 
+(function($){
+    function uiBehaviors(ninja){
+      function watermarkedSubmitter(inputBehavior) {
+        return new ninja.does({
+            priority: 1000,
+            submit: [function(event, el, oldHandler) {
+                inputBehavior.prepareForSubmit()
+                oldHandler(event)
+              }, "andDoDefault"]
+          })
+      }
+      function isWatermarkedPassword(configs) {
+        return new ninja.does({
+            priority: 1000,
+            helpers: {
+              prepareForSubmit: function() {
+                if($(this.element).hasClass('ninja_watermarked')) {
+                  $(this.element).val('')
+                }
+              },
+            },
+            transform: function(element) {
+              var label = $('label[for=' + $(element)[0].id + ']')
+              if(label.length == 0) {
+                this.cantTransform()
+              }
+              label.addClass('ninja_watermarked')
+              this.watermarkText = label.text()
+
+              var el = $(element)
+              el.addClass('ninja_watermarked')
+              el.val(this.watermarkText)
+              el.attr("type", "text")
+
+              this.applyBehaviors(el.parents('form')[0], [watermarkedSubmitter(this)])
+
+              return element
+            },
+            events: {
+              focus: function(event) {
+                $(this.element).removeClass('ninja_watermarked').val('').attr("type", "password")
+              },
+              blur: function(event) {
+                if($(this.element).val() == '') {
+                  $(this.element).addClass('ninja_watermarked').val(this.watermarkText).attr("type", "text")
+                }
+              }
+            }
+          })
+      }
+
+      function isWatermarkedText(configs) {
+        return new ninja.does({
+            priority: 1000,
+            helpers: {
+              prepareForSubmit: function() {
+                if($(this.element).hasClass('ninja_watermarked')) {
+                  $(this.element).val('')
+                }
+              },
+            },
+            transform: function(element) {
+              var label = $('label[for=' + $(element)[0].id + ']')
+              if(label.length == 0) {
+                this.cantTransform()
+              }
+              label.addClass('ninja_watermarked')
+              this.watermarkText = label.text()
+              var el = $(element)
+              el.addClass('ninja_watermarked')
+              el.val(this.watermarkText)
+
+              this.applyBehaviors(el.parents('form')[0], [watermarkedSubmitter(this)])
+
+              return element
+            },
+            events: {
+              focus: function(event) {
+                $(this.element).removeClass('ninja_watermarked').val('')
+              },
+              blur: function(event) {
+                if($(this.element).val() == '') {
+                  $(this.element).addClass('ninja_watermarked').val(this.watermarkText)
+                }
+              }
+            }
+          })
+      }
+
+      return {
+        isWatermarked: function(configs) {
+          return new ninja.chooses(function(meta) {
+              meta.asText = isWatermarkedText(configs)
+              meta.asPassword = isWatermarkedPassword(configs)
+            },
+            function(elem) {
+              if($(elem).is("input[type=text],textarea")) {
+                return this.asText
+              }
+              //Seems IE has a thing about changing input types...
+              //We'll get back to this one
+//              else if($(elem).is("input[type=password]")){
+//                return this.asPassword
+//              }
+            })
+        }
+      }
+    }
+
+    Ninja.packageBehaviors(uiBehaviors)
+  })(jQuery);
+
 
 //This exists to carry over interfaces from earlier versions of Ninjascript.  Likely, it will be removed from future versions of NinjaScript
 ( function($) {

data/lib/generators/mizugumo/install/templates/stylesheets/mizugumo.css

@@ -1,4 +1,4 @@
-.ninja.busy {
+.ninja_busy {
   background-color: white;
   background-image: url("/images/ui/spinner.gif");
   background-position: center center;
@@ -6,6 +6,14 @@
   opacity: 0.75;
   filter: "progid:DXImageTransform.Microsoft.Alpha(opacity=75)"; }
 
+input.ninja_watermarked, textarea.ninja_watermarked {
+  color: #666688;
+  font-style: italic;
+  opacity: 0.75; }
+
+label.ninja_watermarked {
+  display: none; }
+
 form {
   margin: 1em 0;
   padding: 1em;

data/lib/generators/mizugumo/install/templates/stylesheets/sass/mizugumo.sass

@@ -1,4 +1,4 @@
-.ninja.busy
+.ninja_busy
   :background-color white
   :background-image url("/images/ui/spinner.gif")
   :background-position center center
@@ -6,6 +6,14 @@
   :opacity 0.75
   :filter 'progid:DXImageTransform.Microsoft.Alpha(opacity=75)'
 
+input.ninja_watermarked, textarea.ninja_watermarked
+  :color #668
+  :font-style italic
+  :opacity 0.75
+
+label.ninja_watermarked
+  :display none
+
 form
   :margin 1em 0
   :padding 1em

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mizugumo
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
+  hash: 29
+  prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Evan Dorn
@@ -127,9 +127,6 @@ files:
 - lib/generators/rails/mizugumo/view_generator.rb
 - lib/mizugumo.rb
 - lib/mizugumo_link_helper.rb
-- doc/making_generators.txt
-- doc/NAME.haml
-- doc/PURPOSE.haml
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/LRDesign/mizugumo
@@ -161,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Seamless UJS for Rails using NinjaScript

data/doc/NAME.haml

@@ -1,14 +0,0 @@
-%h1 Mizugumo Ᾱ Name
-
-%p
-  'mizugumo' is Japanese for 'water-spider'.  Mythologically, however, it is the
-  name for special wooden shoes that ninja used to walk on water and thereby approach
-  targets via unexpected routes.
-
-%p
-  As much as the Mythbusters were not impressed (real mizugumo likely did not work
-  for actual water-walking, and probably only worked as snowshoes to cross marshy
-  terrain), we thought it an appropriate name for an unobtrusive JS behavior library.
-
-
-

data/doc/PURPOSE.haml

@@ -1,71 +0,0 @@
-%h1 Mizugumo Ᾱ Purpose
-
-%p
-  Mizugumo exists to help Rails developers quickly build apps that are both AJAXy and that degrade
-  gracefully when JavaScript is absent.   It uses NinjaScript to provide unobtrusive javascript
-  behaviors.
-
-%h2 Graceful Degradation
-
-%h3 Why we care
-
-%p
-  Rails developers are notorious for making apps that do not degrade well when JS is unavailable,
-  especially if the app uses AJAX for some actions. It's hard to blame anyone - generally, adding
-  AJAX is a bit of a pain, and adding degradation requires duplicating a lot of development.
-
-%p
-  Ideally, we should put the effort into graceful degradation because we can't count on JavaScript
-  in real-world conditions.   Some situations we care about in which JavaScript might not be
-  available:
-
-  %ul
-    %li NoScript users and other security-conscious folk
-    %li Screen readers for vision-impaired users
-    %li Search engines and spiders, which should see as accurate
-    %li Automation tools
-
-%h3 How to solve the problem
-
-%p
-  Because the client sees the normal, JS-enabled behavior, and because we are all busy people,
-  Rails developers usually won't make their sites degrade gracefully until it becomes no harder
-  to build in graceful degradation than not to.    Mizugumo aspires to this goal.
-
-%p
-  Mizugumo replaces some of rails' default behavior that depend on JS with ones that work
-  in the absence of JS.  Specifically, link_to with a :method option other than GET actually
-  outputs a <form>, not an <a href='foo'>.   It then provides a default javascript behavior,
-  written in NinjaScript, to implicitly convert those forms
-
-%p
-  Mizugumo also provides a scaffold tool that gives you an out-of-the box AJAX controller
-  in which all actions degrade perfectly in the absence of JS.  From that scaffold, it becomes
-  much easier to build rich behaviors into your sites while maintaining JS-less functionality.
-
-%h2 The Philosophy of Ninja-like Unobtrusiveness
-
-%p
-  The goal of Mizugumo's JS engine, NinjaScript, is to make javascript super easy to use, and
-  reliable for the developer &%8212; no surprises.
-
-%3 CSS is Great, JS Sucks
-
-%p
-  We take for granted CSS's super-easy behavior:  specify a selector and add a style.  That style
-  will always apply to anything that matches that selector, even if the DOM is restructured.  JavaScript
-  is not like this, however: if we use a library (say jQuery) to bind events to a selector, event
-  handlers will get bound to the DOM nodes that match that selector *now*, but elements that get added
-  later are out of luck.   We can fix event handlers with event delegation methods, but that still
-  doesn't help us if what we want to do is transform elements.   If I write a javascript block to
-  add rounded corners to a bunch of elements, or to add tooltip elements to a bunch of <li> nodes,
-  it will only make those changes to the elements that match at the time it is run.
-
-%p
-  NinjaScripts aims to make JS as much like CSS as possible: specify a behavior once - including
-  transformations of the elements themselves - and those behaviors will always apply to all elements
-  even if the elements are added to the DOM later.   So you can say "all divs with class .foo
-  get rounded corners" or "all forms matching .mizugomo_graceful_form  get replaced with
-  links with the text matching the submit button text" and likewise not worry about when
-  and how said forms get added to the DOM.
-

data/doc/making_generators.txt

@@ -1,45 +0,0 @@
-These are notes to myself to hopefully avoid this kind of suffering again.
-
-I ran into some troubles (a few hours worth)  trying to get the generators
-working.
-
-Rails wants to load generators from specific "namespaces", but parts of those
-namespaces are automatically generated.   In particular, when a generator is
-invoked, it will generally be looked for with both a "base" and a "context".
-Rails will use *one* of these two when looking, for example, it will look for:
-
-   <base>/<your generator>     and    <your generator>/<context>.
-
-These are interdependent; particularly, setting up a scaffold_controller
-generator will cause part of it's namespace to be assumed when looking for
-the other items, like template_engine and test_framework.
-
-For example, setting scaffold_generator to "ninja_helper:scaffold_controller"
-will cause it to assume a base of "ninja_helper" and a context of "scaffold"
-when you run "rails generate scaffold", which will make it look for your view
-generator in "ninja_helper:erb" and "erb:scaffold", even if you don't explicitly
-set template_engine to anything.
-
-The fix for this was to specify the hooks for template_engine etc. with an
-:in => :rails parameter which causes it to look in the rails namespace
-(and thus retrieve the defaults) unless configs in application.rb specifically
-override those generators.
-
-Ultimately, Rails will generate eight acceptable namespaces for the
-generator based on the requested name in config in application.rb
-***It must live in one of those paths on the filesystem.***  However, the
-actual ruby module namespace does not need to match (seems to be irrelevant).
-The Rails 'namespace' can be massaged just by setting self.namespace(blah)
-in the class, for example:
-
-  self.namespace("rails:ninja_helper:erb")
-
-This lives in generators/rails/ninja_helper/erb_generator.rb, which is
-one of the acceptable namespaces/paths for a beast with this config:
-
-config.generators do |g|
-  g.template_engine 'ninja_helper:erb'
-end
-
-
-