mizugumo 0.1.5 → 0.2.0

data/Gemfile.lock

@@ -1,8 +1,6 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    archive-tar-minitar (0.5.2)
-    columnize (0.3.4)
     diff-lcs (1.1.2)
     git (1.2.5)
     haml (3.0.25)
@@ -10,8 +8,6 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
     rake (0.8.7)
     rcov (0.9.9)
     rspec (2.4.0)
@@ -22,16 +18,6 @@ GEM
     rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.4.0)
-    ruby-debug-base19 (0.11.25)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
 
 PLATFORMS
   ruby
@@ -42,4 +28,3 @@ DEPENDENCIES
   jeweler (~> 1.5.2)
   rcov
   rspec (>= 1.5)
-  ruby-debug19

data/Rakefile

@@ -21,7 +21,6 @@ namespace :update do
     #cp File.join(File.dirname(__FILE__), '..', 'NinjaScript', 'javascript', 'jquery.ninja_script.js'),
        #File.join(File.dirname(__FILE__), 'lib', 'generators', 'mizugumo', 'install', 'templates', 'javascripts')
     mkdir_p 'temp'
-    sh 'rm -f temp/ninjascript.zip'
     sh 'cd temp; wget --no-check-certificate https://github.com/downloads/LRDesign/NinjaScript/ninjascript.zip'
     sh 'cd temp; unzip ninjascript.zip'
     cwd = File.dirname(__FILE__)

data/doc/NAME.haml

@@ -0,0 +1,14 @@
+%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

@@ -0,0 +1,71 @@
+%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

@@ -0,0 +1,167 @@
+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 "mizugumo:scaffold_controller"
+will cause it to assume a base of "mizugumo" and a context of "scaffold"
+when you run "rails generate scaffold", which will make it look for your view
+generator in "mizugumo: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:mizugumo:erb")
+
+This lives in generators/rails/mizugumo/erb_generator.rb, which is
+one of the acceptable namespaces/paths for a beast with this config:
+
+config.generators do |g|
+  g.template_engine 'mizugumo:erb'
+end
+
+Without the self.namespace line in the generator file, Thor would think that
+the generator only has namespace "mizugumo:erb", and wouldn't find it.
+
+
+-----------------------------------
+Debugging this  horseshit:
+
+add debugger lines to self.find_by_namespace and self.lookup in gems/railties-<version>/lib/rails/generators.rb.
+
+Examples follow
+
+    def self.find_by_namespace(name, base=nil, context=nil) #:nodoc:
+      @debug = name =~ /js_assets/
+      lookups = []
+      lookups << "#{base}:#{name}"    if base
+      lookups << "#{name}:#{context}" if context
+
+      unless base || context
+        unless name.to_s.include?(?:)
+          lookups << "#{name}:#{name}"
+          lookups << "rails:#{name}"
+        end
+        lookups << "#{name}"
+      end
+      
+      lookup(lookups)
+
+      namespaces = Hash[subclasses.map { |klass| [klass.namespace, klass] }]
+
+      require 'pp' if @debug
+      pp :namespaces => namespaces if @debug
+
+      lookups.each do |namespace|
+        klass = namespaces[namespace]
+        p :namespace => namespace if @debug
+        p :namespaces_namespace => namespaces[namespace] if @debug
+        p :klass => klass if @debug
+        return klass if klass
+      end
+
+      invoke_fallbacks_for(name, base) || invoke_fallbacks_for(context, name)
+    end
+
+
+
+  # Receives namespaces in an array and tries to find matching generators
+      # in the load path.
+      def self.lookup(namespaces) #:nodoc:
+        p :namespaces => namespaces if @debug
+        load_generators_from_railties!
+        paths = namespaces_to_paths(namespaces)
+        
+        p :paths => paths if @debug
+        paths.each do |raw_path|
+          ["rails/generators", "generators"].each do |base|
+            path = "#{base}/#{raw_path}_generator"
+
+            p :path => path if @debug
+
+            begin
+              require path
+              p "Successfully Loaded Path" => path if @debug
+              require 'pp' if @debug
+              pp :calltrace => caller[0..5] if @debug
+              return
+            rescue LoadError => e
+              p "LoadError for #{path}" if @debug
+              raise unless e.message =~ /#{Regexp.escape(path)}$/
+            rescue NameError => e
+              p "NameError for #{path}" if @debug
+              raise unless e.message =~ /Rails::Generator([\s(::)]|$)/
+              warn "[WARNING] Could not load generator #{path.inspect} because it's a Rails 2.x generator, which is not supported anymore. Error: #{e.message}.\n#{e.backtrace.join("\n")}"
+            rescue Exception => e
+              p "Other exception for #{path}" if @debug
+              warn "[WARNING] Could not load generator #{path.inspect}. Error: #{e.message}.\n#{e.backtrace.join("\n")}"
+            end
+          end
+        end
+      end
+
+
+--------------------------------
+
+Example of the above running whil looking for the mizugumo:js_assets generator:
+
+
+{:namespaces=>["rails:mizugumo:js_assets", "mizugumo:js_assets:scaffold"]}
+{:paths=>["rails/mizugumo/js_assets/js_assets", "rails/mizugumo/js_assets", "mizugumo/js_assets/scaffold/scaffold", "mizugumo/js_assets/scaffold"]}
+{:path=>"rails/generators/rails/mizugumo/js_assets/js_assets_generator"}
+"LoadError for rails/generators/rails/mizugumo/js_assets/js_assets_generator"
+{:path=>"generators/rails/mizugumo/js_assets/js_assets_generator"}
+"LoadError for generators/rails/mizugumo/js_assets/js_assets_generator"
+{:path=>"rails/generators/rails/mizugumo/js_assets_generator"}
+"LoadError for rails/generators/rails/mizugumo/js_assets_generator"
+{:path=>"generators/rails/mizugumo/js_assets_generator"}
+{"Successfully Loaded Path"=>"generators/rails/mizugumo/js_assets_generator"}
+{:calltrace=>
+  ["/Users/evan/.rvm/gems/ruby-1.9.2-p0@test_mg/gems/railties-3.1.1/lib/rails/generators.rb:302:in `each'",
+   "/Users/evan/.rvm/gems/ruby-1.9.2-p0@test_mg/gems/railties-3.1.1/lib/rails/generators.rb:302:in `block in lookup'",
+   "/Users/evan/.rvm/gems/ruby-1.9.2-p0@test_mg/gems/railties-3.1.1/lib/rails/generators.rb:301:in `each'",
+   "/Users/evan/.rvm/gems/ruby-1.9.2-p0@test_mg/gems/railties-3.1.1/lib/rails/generators.rb:301:in `lookup'",
+   "/Users/evan/.rvm/gems/ruby-1.9.2-p0@test_mg/gems/railties-3.1.1/lib/rails/generators.rb:150:in `find_by_namespace'",
+   "/Users/evan/.rvm/gems/ruby-1.9.2-p0@test_mg/gems/railties-3.1.1/lib/rails/generators/base.rb:345:in `prepare_for_invocation'"]}
+{:namespaces=>
+  {"rails:mizugumo:scaffold_controller"=>Mizugumo::ScaffoldControllerGenerator,
+   "mizugumo:view"=>Mizugumo::ViewGenerator,
+   "rails:mizugumo:erb"=>Mizugumo::ErbGenerator,
+   "mizugumo:install"=>Mizugumo::Generators::InstallGenerator,
+   "rails:model"=>Rails::Generators::ModelGenerator,
+   "rails:resource"=>Rails::Generators::ResourceGenerator,
+   "rails:scaffold"=>Rails::Generators::ScaffoldGenerator,
+   "active_record:model"=>ActiveRecord::Generators::ModelGenerator,
+   "test_unit:model"=>TestUnit::Generators::ModelGenerator,
+   "test_unit:scaffold"=>TestUnit::Generators::ScaffoldGenerator,
+   "rails:helper"=>Rails::Generators::HelperGenerator,
+   "test_unit:helper"=>TestUnit::Generators::HelperGenerator,
+   "rails:mizugumo:js_assets"=>Mizugumo::JsAssetsGenerator}}
+{:namespace=>"rails:mizugumo:js_assets"}
+{:namespaces_namespace=>Mizugumo::JsAssetsGenerator}
+{:klass=>Mizugumo::JsAssetsGenerator}
+      invoke  mizugumo:js_assets
+
+
+

data/lib/generators/mizugumo/install/templates/javascripts/ninjascript.js

@@ -2050,7 +2050,6 @@ define('ninja/behaviors',["ninja/exceptions"], function(Exceptions) {
       },
       buildHandler: function(context, eventName, previousHandler) {
         var handle
-        var fallThrough = true
         var stopDefault = true
         var stopPropagate = true
         var stopImmediate = false
@@ -2066,13 +2065,7 @@ define('ninja/behaviors',["ninja/exceptions"], function(Exceptions) {
           var len = config.length
           for(var i = 0; i < len; i++) {
             var found = true
-            if (config[i] == "dontContinue" ||
-              config[i] == "overridesOthers") {
-              fallThrough = false
-            }
-            if (config[i] == "andDoDefault" || 
-              config[i] == "continues" ||
-              config[i] == "allowDefault") {
+            if (config[i] == "andDoDefault" || config[i] == "allowDefault") {
               stopDefault = false
             }
             if (config[i] == "allowPropagate" || config[i] == "dontStopPropagation") {
@@ -2091,21 +2084,13 @@ define('ninja/behaviors',["ninja/exceptions"], function(Exceptions) {
           }
         }
         var handler = function(eventRecord) {
-          handle.call(context, eventRecord, this)
-          if(!eventRecord.isFallthroughPrevented()) {
-            previousHandler.call(context, eventRecord)
-          }
+          handle.call(context, eventRecord, this, previousHandler)
           if(stopDefault){
             return false
           } else {
             return !eventRecord.isDefaultPrevented()
           }
         }
-        if(!fallThrough) {
-          handler = this.prependAction(handler, function(eventRecord) {
-              eventRecord.preventFallthrough()
-            })
-        }
         if(stopDefault) {
           handler = this.prependAction(handler, function(eventRecord) {
               eventRecord.preventDefault()
@@ -2126,12 +2111,6 @@ define('ninja/behaviors',["ninja/exceptions"], function(Exceptions) {
               Ninja.tools.fireMutationEvent()
             })
         }
-        handler = this.prependAction(handler, function(eventRecord) {
-            eventRecord.isFallthroughPrevented = function(){ return false };
-            eventRecord.preventFallthrough = function(){
-              eventRecord.isFallthroughPrevented =function(){ return true };
-            }
-          })
 
         return handler
       },
@@ -3914,7 +3893,7 @@ define('ninja/behaviors/standard',["ninja", "utils"],
             { busyElement: undefined })
 
           return new ninja.does({
-              priority: 10,
+              priority: 20,
               helpers: {
                 findOverlay: function(elem) {
                   return this.deriveElementsFrom(elem, configs.busyElement)
@@ -4299,17 +4278,16 @@ define('ninja/behaviors/confirm',["ninja"],
             function confirmDefault(event,elem) {
               if(!confirm(configs.confirmMessage(elem))) {
                 event.preventDefault()
-                event.preventFallthrough()
               }
             }
 
             return new ninja.selects({
                 "form": new ninja.does({
-                  priority: 20,
+                  priority: -100,
                   events: { submit: [confirmDefault, "andDoDefault"] }
                 }),
                 "a,input": new ninja.does({
-                  priority: 20,
+                  priority: -100,
                   events: {  click: [confirmDefault, "andDoDefault"] }
                 })
               })

data/lib/mizugumo_link_helper.rb

@@ -34,7 +34,7 @@ module MizugumoLinkHelper
         title = "block was passed"
       else
         title = contents
-        submit_element = button_tag(title, :type => 'submit')
+        submit_element = submit_tag(title)
       end
     end
     options       = args[0] || {}

metadata

@@ -1,90 +1,94 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mizugumo
-version: !ruby/object:Gem::Version
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.1.5
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Evan Dorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  prerelease: false
-  type: :development
+
+date: 2011-10-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
   prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  prerelease: false
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.2
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
         version: 1.5.2
-- !ruby/object:Gem::Dependency
-  prerelease: false
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! "Seamless UJS for Rails using NinjaScript.\n    Get RESTFul delete
-  links that work without JavaScript and AJAXy\n    behavior that degrades gracefully
-  right out of your scaffold!\n  "
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: "Seamless UJS for Rails using NinjaScript.\n    Get RESTFul delete links that work without JavaScript and AJAXy\n    behavior that degrades gracefully right out of your scaffold!\n  "
 email: evan@lrdesign.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - .document
 - Gemfile
 - Gemfile.lock
@@ -127,30 +131,43 @@ 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
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib/
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Seamless UJS for Rails using NinjaScript
 test_files: []
+