mjs 0.0.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,89 @@
+Mjs
+===
+
+A slice for the Merb framework that offers Ajax actions like RJS with jQuery
+This privides new 'link_to' method for clients and 'page' object for servers.
+
+
+Methods
+=======
+
+* Merb::Controller#link_to(name, url='', opts={})
+    link_to now recognize :remote, :submit option
+
+* Merb::Controller#page
+    page method is reserved for RJS object.
+    You can access dom elements by it as many times and in anywhere.
+    No more ugly render(:update) block, just type 'page' as you want! 
+
+
+Setup
+=====
+
+Include jQuery as usual
+
+app/views/layouts/application.html.erb:
+  <%= js_include_tag  "jquery.js" -%>
+
+
+Example1
+========
+[ajax get request]
+
+1. Add :remote option to create ajax link
+
+    app/views/top/index.html.erb:
+       <div id="message"></div>
+       <%= link_to "hello", url(:action=>"hello"), :remote=>true %>
+                                                   ^^^^^^^^^^^^^
+    generates:
+       <a onclick="; $.getScript('/top/hello'); return false;" href="#">hello</a>
+    
+2. Use 'page' object to respond as RJS.
+
+    app/controllers/top.rb:
+       def hello
+         page[:message].text "Good morning!"
+         return page
+       end      
+
+    generates:
+       $("#message").text("Good morning!");
+
+
+Example2
+========
+[ajax post request]
+
+1. Add :submit option to specify a DOM element that should be serialized
+
+    app/views/top/index.html.erb:
+       <div id="edit">
+         <%= text_field ... %>
+         <%= text_area  ... %>
+         <%= link_to "update", url(:action=>"update"), :submit=>:edit %>
+                                                        ^^^^^^^^^^^^^
+    generates:
+        <a onclick="; $.post('/top/update', $('#edit input').serialize(), null, 'script');; return false;" href="#">update</a>
+    
+2. enjoy 'page' as you like
+
+    app/controllers/top.rb:
+       def update(id)
+         @item = Item.find(id)
+         ... # update logic is here
+         page[:message].text "successfully saved"
+         update_canvas_for(@item)
+         return page
+       end      
+
+       private
+         def update_canvas_for(item)
+           page[:workspace].html partial("record", :item=>item)
+         rescue => error
+           page[:message].text error.to_s
+           page << "alert('something wrong!')"
+         end
+
+
+Copyright (c) 2008 maiha@wota.jp, released under the MIT license

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "mjs"
+AUTHOR = "maiha"
+EMAIL = "maiha@wota.jp"
+HOMEPAGE = "http://github.com/maiha/mjs"
+SUMMARY = "A slice for the Merb framework that offers Ajax actions like RJS with jQuery"
+GEM_VERSION = "0.0.6"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-slices', '>= 1.0.7.1')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'spec/rake/spectask'
+require 'merb-core/test/tasks/spectasks'
+desc 'Default: run spec examples'
+task :default => 'spec'

data/TODO

@@ -0,0 +1,15 @@
+TODO:
+
+- Fix Mjs.description and Mjs.version
+- Fix LICENSE with your name
+- Fix Rakefile with your name and contact info
+- Add your code to lib/mjs.rb
+- Add your Merb rake tasks to lib/mjs/merbtasks.rb
+
+Remove anything that you don't need:
+
+- app/controllers/main.rb Mjs::Main controller
+- app/views/layout/mjs.html.erb
+- spec/controllers/main_spec.rb controller specs
+- public/* any public files
+- stubs/* any stub files

data/app/controllers/application.rb

@@ -0,0 +1,5 @@
+class Mjs::Application < Merb::Controller
+  
+  controller_for_slice
+  
+end

data/app/controllers/main.rb

@@ -0,0 +1,7 @@
+class Mjs::Main < Mjs::Application
+  
+  def index
+    render
+  end
+  
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,63 @@
+module Merb
+  module Mjs
+    module ApplicationHelper
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def image_path(*segments)
+        public_path_for(:image, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def javascript_path(*segments)
+        public_path_for(:javascript, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def stylesheet_path(*segments)
+        public_path_for(:stylesheet, *segments)
+      end
+      
+      # Construct a path relative to the public directory
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def public_path_for(type, *segments)
+        ::Mjs.public_path_for(type, *segments)
+      end
+      
+      # Construct an app-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the host application, with added segments.
+      def app_path_for(type, *segments)
+        ::Mjs.app_path_for(type, *segments)
+      end
+      
+      # Construct a slice-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the slice source (Gem), with added segments.
+      def slice_path_for(type, *segments)
+        ::Mjs.slice_path_for(type, *segments)
+      end
+      
+    end
+  end
+end

data/app/views/layout/mjs.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <title>Fresh Mjs Slice</title>
+    <link href="<%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all" />
+    <script src="<%= public_path_for :javascript, 'master.js' %>" type="text/javascript" charset="utf-8"></script>
+  </head>
+  <!-- you can override this layout at slices/mjs/app/views/layout/mjs.html.erb -->
+  <body class="mjs-slice">
+  <div id="container">
+	  <h1>Mjs Slice</h1>
+    <div id="main"><%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/app/views/main/index.html.erb

@@ -0,0 +1 @@
+<strong><%= slice.description %></strong> (v. <%= slice.version %>)

data/lib/mjs/helper.rb

@@ -0,0 +1,165 @@
+require 'mjs/java_script_context'
+
+module Mjs
+  module Helper
+    def page
+      @page ||= Mjs::JavaScriptContext.new
+    end
+
+    def remote_function(opts)
+      build_href(opts)
+      unless opts[:submit]
+        opts[:url] ||= opts[:href]
+        opts[:dataType] = "script"
+      end
+      function = "jQuery.ajax(%s);" % options_for_ajax(opts)
+      confirm  = opts.delete(:confirm)
+      function = "if (confirm('#{escape_javascript(confirm)}')) { #{function}; }" if confirm
+      return function
+    end
+
+    # experimental: not tested yet
+    def button_to(name, url='', opts={})
+      ajax = remote_function(opts)
+      opts[:type] = 'button'
+      opts[:value] = name
+      opts[:remote] ||= true if opts[:submit]
+      if opts.delete(:remote)
+        ajax = remote_function(opts)
+        opts[:onclick] = "#{opts.delete(:onclick)}; #{ajax}; return false;"
+      end
+      %{<input #{ opts.to_xml_attributes }>}
+    end
+
+    # override! :link_to # for Ajax
+    def link_to(name, url='', opts={})
+      opts[:href]   ||= url
+      opts[:remote] ||= true if opts[:submit]
+      return super unless opts.delete(:remote)
+
+      ajax = remote_function(opts)
+      opts[:onclick] = "#{opts.delete(:onclick)}; #{ajax}; return false;"
+      opts[:href] = '#'
+      %{<a #{ opts.to_xml_attributes }>#{name}</a>}
+    end
+
+    ######################################################################
+    ### derived from actionpack
+
+    JS_ESCAPE_MAP = {
+      '\\'    => '\\\\',        '</'    => '<\/',
+      "\r\n"  => '\n',
+      "\n"    => '\n',        "\r"    => '\n',
+      '"'     => '\\"',
+      "'"     => "\\'" }
+
+    # Escape carrier returns and single and double quotes for JavaScript segments.
+    def escape_javascript(javascript)
+      if javascript
+        javascript.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { JS_ESCAPE_MAP[$1] }
+      else
+        ''
+      end
+    end
+
+    private
+      def build_href(opts)
+        if opts[:href].is_a?(DataMapper::Resource)
+          record = opts[:href]
+          if record.new_record?
+            opts[:href] = resource(record.class.name.downcase.pluralize.intern, :new)
+          else
+            opts[:href] = resource(record)
+          end
+        end
+        opts
+      end
+
+      AJAX_FUNCTIONS = {
+        :before      => :beforeSend,
+        :before_send => :beforeSend,
+        :beforeSend  => :beforeSend,
+        :complete    => :complete,
+        :success     => :success,
+        :error       => :error,
+        :dataFilter  => :dataFilter,
+        :data_filter => :dataFilter,
+        :xhr         => :xhr,
+      }
+
+
+      def options_for_ajax(options)
+        js_options = build_callbacks!(options)
+
+        submit = options.delete(:submit)
+        target =
+          case submit
+          when Symbol then "jQuery('##{submit} input, ##{submit} select, ##{submit} textarea')"
+          when String then "jQuery('#{submit}')"
+          when NilClass    # GET requst
+          else
+            raise ArgumentError, "link_to :submit expects Symbol or String, but got #{submit.class.name}"
+          end
+        build_href(options)
+
+        if target
+          js_options[:type] = "'POST'"
+          js_options[:data] = "#{target}.serialize()"
+        end
+        js_options[:url]  = "'#{options[:url] || options[:href]}'"
+        js_options[:dataType] = "'script'"
+
+        if js_options[:url].blank?
+          raise "Cannot build ajax options because url is blank. (#{options.inspect})"
+        end
+
+        options_for_javascript(js_options)
+      end
+
+      def options_for_javascript(options)
+        if options.empty?
+          '{}'
+        else
+          "{#{options.keys.map { |k| "#{k}:#{options[k]}" }.sort.join(', ')}}"
+        end
+      end
+
+      def jquery_selector(key)
+        case key
+        when Symbol then "jQuery('##{key}')"
+        when String then "jQuery('#{key}')"
+        else
+          raise "invalid jquery selector: [#{key.class}] #{key}"
+        end
+      end
+
+      # this method affects "options"
+      def build_callbacks!(options)
+        callbacks = {}
+
+        [:before, :complete].each do |event|
+          options[event] = Array(options[event])
+        end
+
+        # special callback (:spinner)
+        if options[:spinner]
+          target = jquery_selector(options.delete(:spinner))
+          options[:before]   << "#{target}.show()"
+          options[:complete] << "#{target}.hide()"
+        end
+
+        [:before, :complete].each do |event|
+          options[event] = options[event].compact * ';'
+        end
+
+        options.each do |callback, code|
+          if (name = AJAX_FUNCTIONS[callback])
+            callbacks[name.to_s] = "function(request){#{code}}"
+            options.delete(callback)
+          end
+        end
+
+        callbacks
+      end
+  end
+end