mack-javascript 0.6.1

data/lib/mack-javascript/helpers/jquery_helper.rb

@@ -0,0 +1,125 @@
+module Mack
+  module JavaScript
+    module Framework
+      class Jquery      
+        class << self
+          def insert_html(position, id, html)
+            insertion = position.to_s.downcase
+            insertion = 'append' if insertion == 'bottom'
+            insertion = 'prepend' if insertion == 'top'
+            "$(\"##{id}\").#{insertion}('#{html}')"
+          end
+
+          def replace_html(id, html)
+            insert_html(:html, id, html)
+          end
+
+          def replace(id, html)
+            "$(\"##{id}\").replaceWith('#{html}')"
+          end
+
+          def remove(*ids)
+            "$(\"##{ids.join(',#')}\").remove()"
+          end
+
+          def show(*ids)
+            "$(\"##{ids.join(',#')}\").show()"
+          end
+
+          def hide(*ids)
+            "$(\"##{ids.join(',#')}\").hide()"
+          end
+
+          def toggle(*ids)
+            "$(\"##{ids.join(',#')}\").toggle()"
+          end
+
+
+          # def draggable(id, options = {})
+          #   record @context.send(:draggable_element_js, id, options)
+          # end
+          # 
+          # def visual_effect(name, id = nil, options = {})
+          #   record @context.send(:visual_effect, name, id, options)
+          # end
+          # 
+          # def drop_receiving(id, options = {})
+          #   record @context.send(:drop_receiving_element_js, id, options)
+          # end
+          # 
+          def remote_function(options)
+            javascript_options = options_for_ajax(options)
+            update = ''
+            if options[:update] && options[:update].is_a?(Hash)
+              update  = []
+              update << "success:'#{options[:update][:success]}'" if options[:update][:success]
+              update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
+              update  = '{' + update.join(',') + '}'
+            elsif options[:update]
+              update << "'#{options[:update]}'"
+            end
+
+            function = "$.ajax(#{javascript_options})"
+
+            function = "#{options[:before]}; #{function}" if options[:before]
+            function = "#{function}; #{options[:after]}"  if options[:after]
+            function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
+            function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]
+            return function
+          end
+
+          protected
+          def options_for_ajax(options)
+            js_options = build_callbacks(options)
+            js_options['url'] = "'#{options[:url]}'"
+            js_options['async'] = options[:type] != :synchronous        
+            js_options['type'] = options[:method] ? "'#{options[:method]}'" : "'post'"
+            js_options['dataType'] = options[:datatype] ? "'#{options[:datatype]}'" : (options[:update] ? nil : "'script'")
+
+            if options[:form]
+              js_options['data'] = "$.param($(this).serializeArray())"
+            elsif options[:submit]
+              js_options['data'] = "$(\"##{options[:submit]}\").serializeArray()"
+            elsif options[:with]
+              js_options['data'] = options[:with].gsub('Form.serialize(this.form)','$.param($(this.form).serializeArray())')
+            end
+            options_for_javascript(js_options.reject {|key, value| value.nil?})
+          end
+
+          def options_for_javascript(options)
+            '{' + options.map {|k, v| "#{k}:#{v}"}.sort.join(', ') + '}'
+          end
+
+          def build_callbacks(options)
+            callbacks = {}
+            options[:beforeSend] = '';
+            [:uninitialized,:loading,:loaded].each do |key|
+              options[:beforeSend] << (options[key].last == ';' ? options.delete(key) : options.delete(key) << ';') if options[key]
+            end
+            options.delete(:beforeSend) if options[:beforeSend].blank?
+            options[:error] = options.delete(:failure) if options[:failure]
+            if options[:update]
+              options[:success] = build_update(options) << (options[:success] ? options[:success] : '')
+            end
+            options.each do |callback, code|
+              if [:beforeSend, :complete, :error, :success ].include?(callback)
+                callbacks[callback] = "function(request){#{code}}"
+              end
+            end
+            callbacks
+          end
+
+          def build_update(options)
+            insertion = 'html'
+            insertion = options[:position].to_s.downcase if options[:position]
+            insertion = 'append' if insertion == 'bottom'
+            insertion = 'prepend' if insertion == 'top'
+            "$('##{options[:update]}').#{insertion}(request);"
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/mack-javascript/helpers/prototype_helper.rb

@@ -0,0 +1,112 @@
+module Mack
+  module JavaScript
+    module Framework
+      class Prototype
+        @@callbacks = [:uninitialized, :loading, :loaded, :interactive, :complete, :failure, :success ] + 
+        [100,101] + (200..206).to_a + (300..307).to_a + (400..417).to_a + (500..505).to_a
+        class << self
+          def insert_html(position, id, html)
+            insertion = position.to_s.camelcase
+            "new Insertion.#{insertion}('#{id}', '#{html}')"
+          end
+
+          def replace_html(id, html)
+            "Element.update('#{id}', '#{html}')"
+          end
+
+          def replace(id, html)
+            "Element.replace('#{id}', '#{html}')"
+          end
+
+          def remove(*ids)
+            "#{ids.to_json}.each(Element.remove)"
+          end
+
+          def show(*ids)
+            "#{ids.to_json}.each(Element.show)"
+          end
+
+          def toggle(*ids)
+            "#{ids.to_json}.each(Element.toggle)"
+          end
+
+          # def draggable(id, options = {})
+          #   record @context.send(:draggable_element_js, id, options)
+          # end
+          # 
+          # def visual_effect(name, id = nil, options = {})
+          #   record @context.send(:visual_effect, name, id, options)
+          # end
+          # 
+          # def drop_receiving(id, options = {})
+          #   record @context.send(:drop_receiving_element_js, id, options)
+          # end
+          # 
+          def remote_function(options)
+            javascript_options = options_for_ajax(options)
+            "new Ajax.Request('#{options[:url]}', #{javascript_options.to_json})"
+            update = ''
+            if options[:update] && options[:update].is_a?(Hash)
+              update  = []
+              update << "success:'#{options[:update][:success]}'" if options[:update][:success]
+              update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
+              update  = '{' + update.join(',') + '}'
+            elsif options[:update]
+              update << "'#{options[:update]}'"
+            end
+
+            function = update.empty? ? 
+            "new Ajax.Request(" :
+            "new Ajax.Updater(#{update}, "
+
+            url_options = options[:url]
+            url_options = url_options.merge(:escape => false) if url_options.is_a?(Hash)
+            function << "'#{url_options}'"
+            function << ", #{javascript_options})"
+
+            function = "#{options[:before]}; #{function}" if options[:before]
+            function = "#{function}; #{options[:after]}"  if options[:after]
+            function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
+            function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]
+
+            return function
+          end
+
+          protected
+          def options_for_ajax(options)
+            js_options = build_callbacks(options)
+            js_options['asynchronous'] = options[:type] != :synchronous
+            js_options['method']       = "'#{options[:method]}'" if options[:method]
+            js_options['insertion']    = "Insertion.#{options[:position].to_s.camelize}" if options[:position]
+            js_options['evalScripts']  = options[:script].nil? || options[:script]
+
+            if options[:form]
+              js_options['parameters'] = 'Form.serialize(this)'
+            elsif options[:submit]
+              js_options['parameters'] = "Form.serialize('#{options[:submit]}')"
+            elsif options[:with]
+              js_options['parameters'] = options[:with]
+            end
+            options_for_javascript(js_options.reject {|key, value| value.nil?})
+          end
+
+          def options_for_javascript(options)
+            '{' + options.map {|k, v| "#{k}:#{v}"}.sort.join(', ') + '}'
+          end
+
+          def build_callbacks(options)
+            callbacks = {}
+            options.each do |callback, code|
+              if @@callbacks.include?(callback)
+                name = 'on' + callback.to_s.capitalize
+                callbacks[name] = "function(request){#{code}}"
+              end
+            end
+            callbacks
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/mack-javascript/helpers/script_generator.rb

@@ -0,0 +1,57 @@
+module Mack
+  module JavaScript
+    class ScriptGenerator    
+      def initialize
+        @lines = ''
+      end
+
+      def method_missing(sym, *args)
+        self << self.class.framework.send(sym, *args)
+      end
+
+      def <<(s)
+        @lines << s + ";"
+      end
+
+      def to_s
+        @lines
+      end
+
+      def alert(message)
+        self << "alert('#{message}')"
+      end
+
+      def call(*args, &block)
+        s = args.shift + '('
+        a = []
+        args.each {|arg| a << arg.to_json}
+        self << s + a.join(',') + ')'
+      end
+
+      def assign(variable, value)
+        self << "#{variable} = #{value.to_json}"
+      end
+
+      def delay(seconds = 1, &block)
+        self << "setTimeout(function() {\n\n" + yield(Mack::JavaScript::ScriptGenerator.new) + "}, #{(seconds * 1000).to_i})"
+      end
+
+      class << self
+        
+        def framework
+          "Mack::JavaScript::Framework::#{framework_name}".constantize
+        end
+
+        def framework=(args)
+          @@framework_name = args.camelcase
+        end
+        
+        private
+        def framework_name
+          @@framework_name ||= app_config.mack.js_framework.camelcase
+        end
+      end
+
+    end
+  end
+end

data/lib/mack-javascript/helpers/testing_helpers.rb

@@ -0,0 +1,12 @@
+module Mack
+  module Testing
+    module Helpers
+      #simulates an ajax request
+      def xhr(method, uri, options = {})
+        options = {:input => options.to_params} if method == :post || method == :put
+        build_response(request.send(method, uri, build_request_options(options.merge({"HTTP_X_REQUESTED_WITH" => 'XMLHttpRequest', "HTTP_ACCEPT" => 'text/javascript, text/html, application/xml, text/xml, */*'}))))
+      end
+    end
+  end
+end
+

data/lib/mack-javascript/rendering/engine/rjs.rb

@@ -0,0 +1,33 @@
+module Mack
+  module Rendering # :nodoc:
+    module Engine # :nodoc:
+      # Allows use of the Builder::XmlMarkup engine to be used with rendering.
+      class Rjs < Mack::Rendering::Engine::Base
+        
+        def render(io, binding)
+          @_jsp_page = Mack::JavaScript::ScriptGenerator.new
+          view_template.instance_variable_set("@_jsp_page", @_jsp_page)
+          eval(io, binding)
+          @_jsp_page.to_s
+        end
+        
+        def extension
+          :rjs
+        end
+        
+        module ViewTemplateHelpers
+          def page
+            @_jsp_page
+          end
+        end # ViewTemplateHelpers
+        
+      end # RJS
+    end # Engine
+  end # Rendering
+end # Mack
+
+Mack::Rendering::ViewTemplate.send(:include, Mack::Rendering::Engine::Rjs::ViewTemplateHelpers)
+Mack::Rendering::Engine::Registry.instance.register(:action, :rjs)
+Mack::Rendering::Engine::Registry.instance.register(:template, :rjs)
+Mack::Rendering::Engine::Registry.instance.register(:partial, :rjs)
+Mack::Rendering::Engine::Registry.instance.register(:js, :rjs)

data/lib/mack-javascript/rendering/type/js.rb

@@ -0,0 +1,33 @@
+module Mack
+  module Rendering # :nodoc:
+    module Type # :nodoc:
+      # Used to render an XML template that's relative to a controller.
+      # 
+      # Example:
+      #   class UsersController < Mack::Controller::Base
+      #     # /users/:id
+      #     def show
+      #       @user = User.first(params(:id))
+      #     end
+      #     # /users
+      #     def index
+      #       @users = User.all
+      #       render(:xml, :list)
+      #     end
+      #   end
+      # When some calls /users/1.xml the file: app/views/users/show.xml.builder will be rendered.
+      # When some calls /users.xml the file: app/views/users/list.xml.builder will be rendered.
+      class Js < Mack::Rendering::Type::FileBase
+        
+        # See Mack::Rendering::Type::FileBase render_file for more information.
+        def render
+          self.options[:format] = "js"
+          self.controller.response["Content-Type"] = Mack::Utils::MimeTypes[self.options[:format]]
+          x_file = File.join(self.controller_view_path, "#{self.render_value}.#{self.options[:format]}")
+          render_file(x_file, :js)
+        end
+        
+      end # Xml
+    end # Type
+  end # Rendering
+end # Mack

data/lib/mack-javascript/view_helpers/html_helpers.rb

@@ -0,0 +1,42 @@
+module Mack
+  module ViewHelpers
+    module HtmlHelpers
+      # Renders javascript in an html file
+      #
+      # Example:
+      #     <%= update_page do |page|
+      #           page.alert('this gets translated to js!')
+      #           page.show('my_hidden_div')
+      #         end
+      #     %>
+      #This returns (assuming Prototype is your Js Framework):
+      #     <script type='text/javascript'>
+      #         alert('this gets translated to js!');
+      #         $('my_hidden_div').show();
+      #     </script>
+      def update_page(&block)
+        sg = Mack::JavaScript::ScriptGenerator.new
+        yield(sg)
+        "<script type='#{Mack::Utils::MimeTypes[:js]}'>\n" + sg.to_s.gsub(';', ";\n") + "</script>"
+      end
+      
+      def link_to_remote(link_text, ajax_options, options = {})
+        link_to_function(link_text, remote_function(ajax_options), options)
+      end
+      
+      def link_to_function(link_text, *args, &block)
+        function = args[0] || ''
+        options = args[1] || {}
+        function = yield(Mack::JavaScript::ScriptGenerator.new).chop if block_given?
+        options[:onclick] = (options[:onclick] ? "#{options[:onclick]}; " : "") + "#{function}; return false;" 
+        link_to(link_text, '#', options)
+      end
+      
+      # Returns javascript that does an Ajax call
+      def remote_function(options)
+        Mack::JavaScript::ScriptGenerator.framework.remote_function(options)
+      end
+      
+    end
+  end
+end

data/lib/mack-javascript/view_helpers/string_helpers.rb

@@ -0,0 +1,13 @@
+module Mack
+  module ViewHelpers
+    module StringHelpers
+      
+      # Escapes Javascript
+      #
+      def escape_javascript(javascript)
+        (javascript || '').gsub('\\','\0\0').gsub('</','<\/').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: mack-javascript
+version: !ruby/object:Gem::Version 
+  version: 0.6.1
+platform: ruby
+authors: 
+- Gerardo Pis-Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: RJS support for the Mack Framework
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mack-javascript/generators/javascript_generator.rb
+- lib/mack-javascript/generators/manifest.yml
+- lib/mack-javascript/generators/templates/javascripts/controls.js.template
+- lib/mack-javascript/generators/templates/javascripts/dragdrop.js.template
+- lib/mack-javascript/generators/templates/javascripts/effects.js.template
+- lib/mack-javascript/generators/templates/javascripts/jquery-fx.js.template
+- lib/mack-javascript/generators/templates/javascripts/jquery-ui.js.template
+- lib/mack-javascript/generators/templates/javascripts/jquery.js.template
+- lib/mack-javascript/generators/templates/javascripts/prototype.js.template
+- lib/mack-javascript/helpers/jquery_helper.rb
+- lib/mack-javascript/helpers/prototype_helper.rb
+- lib/mack-javascript/helpers/script_generator.rb
+- lib/mack-javascript/helpers/testing_helpers.rb
+- lib/mack-javascript/rendering/engine/rjs.rb
+- lib/mack-javascript/rendering/type/js.rb
+- lib/mack-javascript/view_helpers/html_helpers.rb
+- lib/mack-javascript/view_helpers/string_helpers.rb
+- lib/mack-javascript.rb
+- README
+has_rdoc: true
+homepage: http://www.mackframework.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: magrathea
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: JavaScript in Mack
+test_files: []
+