kosmas58-compass-jquery-plugin 0.1.8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kosmas Schuetz
+
+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.textile

@@ -0,0 +1,109 @@
+h1. compass-jquery-plugin
+
+Get it from <b>"here":http://github.com/kosmas58/compass-jquery-plugin</b>.
+
+h2. Description
+
+A Sass-based Meta-Framework for Compass that allows you to mix and match any of the following:
+
+* jRails with jQuery and jQuery.UI including themes
+* jqGrid V3.5/edge
+* dynatree V0.50
+
+This library requires <b>"Compass":http://wiki.github.com/chriseppstein/compass</b>. 
+
+h3. jRails, jQuery and jQuery.UI including themes
+
+Use compass to install the jRails, jQuery and jQuery.UI javascript library including themes into your project.
+
+<pre>compass -r jquery -f jquery -p jrails <project name></pre>
+
+You will find all the stylesheets in easy-to-read Sass format at:
+
+<pre>stylesheets/jquery.ui</pre>
+
+To use the localized stylesheets and javacripts include:
+ 
+<pre>
+	= stylesheet_link_tag 'compiled/jquery.ui/[theme].css', :media => 'screen, projection'   
+	= javascript_include_tag :defaults 
+	= jrails_javascripts I18n.locale</pre>
+
+into your layouts.
+
+h3. jQuery Dynatree Plugin
+
+Use compass to install the jQuery Dynatree javascript library into your project.
+
+<pre>compass -f jquery -p dynatree <project name></pre>
+
+You will find all the stylesheets in easy-to-read Sass format at:
+
+<pre>stylesheets/jquery.ui</pre>
+
+To use the localized stylesheets and javacripts include: 
+
+<pre>
+	= stylesheet_link_tag 'compiled/jquery.ui/dynatree.[skin].css', :media => 'screen, projection'  
+ 	= javascript_include_tag 'jquery.dynatree.min'</pre>
+
+h3. jqGrid
+
+Use compass to install the jqGrid javascript library into your project.
+
+<pre>compass -f jquery -p jqgrid <project name></pre>
+
+You will find all the stylesheets in easy-to-read Sass format at:
+
+<pre>stylesheets/jquery.ui</pre>
+
+To use the localized stylesheets and javacripts include: 
+
+<pre>
+  = stylesheet_link_tag 'compiled/jquery.ui/jqGrid.css', :media => 'screen, projection'  
+  = stylesheet_link_tag 'fix_blueprint_jqgrid.css', :media => 'screen, projection'   
+  = jqgrid_javascripts I18n.locale</pre>
+
+jqGrid now uses the jQuery UI Themes. jqGrid has been included as a subproject. You do not need to check it out unless you want to use a different version.
+
+h3. Secret Sauce
+
+Use compass to install the Secret Sauce for jqGrid javascript library into your project.
+
+<pre>compass -f jquery -p secret_sauce <project name></pre>
+
+You will find all the stylesheets in easy-to-read Sass format.
+
+<pre>stylesheets/jquery.ui</pre>
+
+To use the localized stylesheets and javacripts include: 
+
+<pre>
+  = stylesheet_link_tag 'compiled/jquery.ui/secret_sauce.css', :media => 'screen, projection' 
+  = stylesheet_link_tag 'fix_blueprint_jqgrid.css', :media => 'screen, projection'  
+  = javascript_include_tag :secret_sauce</pre>
+
+h2. Thanks to the Contributors:
+
+h3. Rails
+
+* David Turnbull for <b>"compass-jquery":http://github.com/dturnbull/compass-jquery/tree/master</b>
+* aaron for <b>"jRails":http://code.google.com/p/ennerchi/</b>
+* ahe for <b>"2dc_jqgrid":http://github.com/ahe/2dc_jqgrid/tree/master</b>
+* scrubber for <b>"jquery_grid_for_rails":http://github.com/scrubber/jquery_grid_for_rails/tree/master</b>
+* ariesroyaal for <b>"secret_sauce":http://github.com/ariesroyaal/secret_sauce/tree/master</b>
+
+h3. jQuery Plugins included
+
+* Tony Tomov for <b>"jQuery Grid Plugin":http://www.trirand.com/blog/</b>
+* Martin Wendt for <b>"jQuery Dynatree Plugin":http://www.wwwendt.de</b>
+* Andreas Eberhard for <b>"jQuery PngFix Plugin (for IE)":http://jquery.andreaseberhard.de/</b>
+* Kalus Hartl for <b>"jQuery Cookie Plugin (for IE)":http://stilbuero.de</b>
+* John Reisig et. al. for <b>"jQuery Form Plugin":http://malsup.com/jquery/form//</b>
+* Fabrizio Balliano and Fabrizio Balliano for <b>"jQuery Layout Plugin":http://www.fabrizioballiano.net/</b>
+
+h2. Known Issues
+
+* The blueprint css framework doesn't work nicely with jqGrid, because jgGrid has a weak stylesheet.
+* There is an issue with compass installing binary files, so the images coming with the can be corrupted in your app. Until the issue is fixed, you have to copy them by hand from the gem.  
+ 

data/Rakefile

@@ -0,0 +1,9 @@
+begin; require 'rubygems'; rescue LoadError; end
+require 'rake'
+require 'rake/gempackagetask'
+require "rake/clean"
+require "compass"
+require 'lib/jquery.rb'
+
+Dir['gem_tasks/**/*.rake'].each { |rake| load rake }
+

data/lib/handle_js_files.rb

@@ -0,0 +1,35 @@
+GEM_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+YUI_COMPRESSOR = File.join(GEM_ROOT, 'lib', 'yuicompressor-2.4.2.jar')
+
+def compress_js(scripts)
+  min_js = ''
+  IO.popen("java -jar #{YUI_COMPRESSOR} --type js --charset utf8", 'r+') { |f| f.print(scripts); f.close_write; min_js = f.read }
+  min_js
+end
+
+def concat_files(files)
+  out = ''
+  files.each do |file| 
+    out += file
+  end
+  out
+end
+
+def all_files(pattern) 
+  FileList[pattern].collect {|filename| File.read(filename)}.join "\n\n"
+end
+
+def copy_files(src, dest_dir, manifest)
+  unless File.exist? dest_dir
+    FileUtils.mkdir_p dest_dir
+  end
+  Dir.glob(src).each do |file|
+    FileUtils.cp(file, destdir)
+    
+        puts "  copied #{File.basename(file)}"
+  end
+end
+
+
+ 
+      

data/lib/jquery.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'jquery', 'compass_plugin')

data/lib/jquery/compass_plugin.rb

@@ -0,0 +1,5 @@
+options = Hash.new
+options[:stylesheets_directory] = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sass'))
+options[:templates_directory] = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates'))
+
+Compass::Frameworks.register('jquery', options)

data/lib/jquery/jqgrid.rb

@@ -0,0 +1,374 @@
+module ActionView
+  module Helpers
+    
+    def jqgrid_javascripts(locale)
+      js = capture { javascript_include_tag "i18n/jqgrid/locale-#{locale}.min" }    
+      js << capture { javascript_include_tag 'jquery.jqGrid.min' }  
+    end
+
+    def jquery_grid(name, opts={})
+      @@grid_name = name.to_s
+      grid_data = YAML::load_file("#{RAILS_ROOT}/config/jquery/jqGrid/#{name}.yml")
+    
+      before = grid_data[:before]
+      params = grid_data[:params]
+      
+      def param_body(value)
+        value.scan(/^\((.+?)\)(.+)/).flatten
+      end
+      
+      jquery_grid_code = <<-CODE
+          <script type="text/javascript">
+            <%= before %>_n_
+            jQuery(document).ready(function(){ 
+              jQuery("#<%= name %>").jqGrid({               
+              <% params.each do |key,value| %>
+                <% if opts.keys.include?(key) %>
+                  _ss_<%= key %>: <%= opts[key].to_json %>,
+                <% elsif (value.is_a? String) && (value[0..0] == "$") %>
+                  _ss_<%= key %>: <%= "jQuery"+value[1,value.length] %>,
+                <% elsif (key.to_s[0..8] == 'function_') %>
+                  <% js_params, body = param_body(value) %>
+                  _ss_<%= key.to_s[9..-1] %>: function(<%= js_params %>) {
+                    _ss__ss_<%= body %> 
+                  _ss_},
+                <% else %>
+                  _ss_<%= key %>: <%= value.to_json %>,
+                <% end %>
+              <% end %>                            
+              <% opts.each do |key,value| %>
+                <% unless params.keys.include?(key) %>
+                  _ss_<%= key %>: <%= value.to_json %>,
+                <% end %>
+              <% end %> });
+            });
+          </script>
+      CODE
+      ::ERB.new(jquery_grid_code, nil, '>').result(binding).gsub("_n_", "\n").
+      gsub(/[ \t]{2,}/,' ').
+      gsub(/,\s+\}\);/, "\n  });").
+      gsub(/\n\s*\n/m, "\n").
+      gsub("_ss_", "  ").
+      gsub("<grid_name>", @@grid_name)
+    end
+
+
+    def jqgrid(title, id, action, columns = {}, options = {}, edit_options = "", add_options = "", del_options = "", search_options = "")
+      # Default options
+      options[:autowidth] = false if options[:autowidth].blank?
+      options[:hidegrid] = true if options[:hidegrid].nil?
+      options[:rows_per_page] = "10" if options[:rows_per_page].blank?
+      options[:sort_column] = "id" if options[:sort_column].blank?
+      options[:sort_order] = "asc" if options[:sort_order].blank?
+      options[:height] = "150" if options[:height].blank?
+      options[:error_handler] = 'null' if options[:error_handler].blank?
+      options[:error_handler_return_value] = options[:error_handler]
+      options[:error_handler_return_value] = "true;" if options[:error_handler_return_value] == 'null'
+      options[:inline_edit_handler] = 'null' if options[:inline_edit_handler].blank?      
+
+      options[:add] = (options[:add].blank?) ? "false" : options[:add].to_s    
+      options[:delete] = (options[:delete].blank?) ? "false" : options[:delete].to_s
+      options[:inline_edit] = (options[:inline_edit].blank?) ? "false" : options[:inline_edit].to_s
+      edit_button = (options[:edit] == true && options[:inline_edit] == "false") ? "true" : "false" 
+
+      # Generate columns data
+      col_names, col_model = gen_columns(columns)
+
+      # Enable multi-selection (checkboxes)
+      multiselect = ""
+      if options[:multi_selection]
+        multiselect = %Q/multiselect: true,/
+        multihandler = %Q/
+          jQuery("##{id}_select_button").click( function() { 
+            var s; s = jQuery("##{id}").getGridParam('selarrrow'); 
+            #{options[:selection_handler]}(s); 
+            return false;
+          });/
+      end
+
+      # Enable master-details
+      masterdetails = ""
+      if options[:master_details]
+        masterdetails = %Q/
+          onSelectRow: function(ids) { 
+            if(ids == null) { 
+              ids=0; 
+              if(jQuery("##{id}_details").getGridParam('records') >0 ) 
+              { 
+                jQuery("##{id}_details").setGridParam({url:"#{options[:details_url]}?q=1&id="+ids,page:1})
+                .setCaption("#{options[:details_caption]}: "+ids)
+                .trigger('reloadGrid'); 
+              } 
+            } 
+            else 
+            { 
+              jQuery("##{id}_details").setGridParam({url:"#{options[:details_url]}?q=1&id="+ids,page:1})
+              .setCaption("#{options[:details_caption]} : "+ids)
+              .trigger('reloadGrid'); 
+            } 
+          },/
+      end
+
+      # Enable selection link, button
+      # The javascript function created by the user (options[:selection_handler]) will be called with the selected row id as a parameter
+      selection_link = ""
+      if (options[:direct_selection].blank? || options[:direct_selection] == false) && options[:selection_handler].present? && (options[:multi_selection].blank? || options[:multi_selection] == false)
+        selection_link = %Q/
+        jQuery("##{id}_select_button").click( function(){ 
+          var id = jQuery("##{id}").getGridParam('selrow'); 
+          if (id) { 
+            #{options[:selection_handler]}(id); 
+          } else { 
+            alert("Please select a row");
+          }
+          return false; 
+        });/
+      end
+
+      # Enable direct selection (when a row in the table is clicked)
+      # The javascript function created by the user (options[:selection_handler]) will be called with the selected row id as a parameter
+      direct_link = ""
+      if options[:direct_selection] && options[:selection_handler].present? && options[:multi_selection].blank?
+        direct_link = %Q/
+        onSelectRow: function(id){ 
+          if(id){ 
+            #{options[:selection_handler]}(id); 
+          } 
+        },/
+      end
+
+      # Enable grid_loaded callback
+      # When data are loaded into the grid, call the Javascript function options[:grid_loaded] (defined by the user)
+      grid_loaded = ""
+      if options[:grid_loaded].present?
+        grid_loaded = %Q/
+        loadComplete: function(){ 
+          #{options[:grid_loaded]}();
+        },
+        /
+      end
+
+      # Enable inline editing
+      # When a row is selected, all fields are transformed to input types
+      editable = ""
+      if options[:edit] && options[:inline_edit] == "true"
+        editable = %Q/
+        onSelectRow: function(id){ 
+          if(id && id!==lastsel_#{id}){ 
+            jQuery('##{id}').restoreRow(lastsel_#{id});
+            jQuery('##{id}').editRow(id, true, #{options[:inline_edit_handler]}, #{options[:error_handler]});
+            lastsel_#{id}=id; 
+          } 
+        },/
+      end
+      
+      # Enable subgrids
+      subgrid = ""
+      subgrid_enabled = "subGrid:false,"
+      if options[:subgrid]
+        subgrid_enabled = "subGrid:true,"
+        options[:subgrid][:rows_per_page] = "10" if options[:subgrid][:rows_per_page].blank?
+        options[:subgrid][:sort_column] = "id" if options[:subgrid][:sort_column].blank?
+        options[:subgrid][:sort_order] = "asc" if options[:subgrid][:sort_order].blank?
+        subgrid_search = (options[:subgrid][:search].blank?) ? "false" : options[:subgrid][:search]
+        options[:subgrid][:add] = (options[:subgrid][:add].blank?) ? "false" : options[:subgrid][:add].to_s    
+        options[:subgrid][:delete] = (options[:subgrid][:delete].blank?) ? "false" : options[:subgrid][:delete].to_s
+        options[:subgrid][:edit] = (options[:subgrid][:edit].blank?) ? "false" : options[:subgrid][:edit].to_s   
+        
+        subgrid_inline_edit = ""
+        if options[:subgrid][:inline_edit] == true
+          options[:subgrid][:edit] = "false"
+          subgrid_inline_edit = %Q/
+          onSelectRow: function(id){ 
+            if(id && id!==lastsel_#{id}){ 
+              jQuery('#'+subgrid_table_id).restoreRow(lastsel_#{id});
+              jQuery('#'+subgrid_table_id).editRow(id,true); 
+              lastsel_#{id}=id; 
+            } 
+          },
+          /
+        end
+          
+        if options[:subgrid][:direct_selection] && options[:subgrid][:selection_handler].present?
+          subgrid_direct_link = %Q/
+          onSelectRow: function(id){ 
+            if(id){ 
+              #{options[:subgrid][:selection_handler]}(id); 
+            } 
+          },
+          /
+        end     
+        
+        sub_col_names, sub_col_model = gen_columns(options[:subgrid][:columns])
+        
+        subgrid = %Q(
+        subGridRowExpanded: function(subgrid_id, row_id) {
+            var subgrid_table_id, pager_id;
+            subgrid_table_id = subgrid_id+"_t";
+            pager_id = "p_"+subgrid_table_id;
+            $("#"+subgrid_id).html("<table id='"+subgrid_table_id+"' class='scroll'></table><div id='"+pager_id+"' class='scroll'></div>");
+            jQuery$("#"+subgrid_table_id).jqGrid({
+              url:"#{options[:subgrid][:url]}?q=2&id="+row_id,
+              editurl:'#{options[:subgrid][:edit_url]}?parent_id='+row_id,
+              datatype: "json",
+              colNames: #{sub_col_names},
+              colModel: #{sub_col_model},
+                rowNum:#{options[:subgrid][:rows_per_page]},
+                pager: pager_id,
+                sortname: '#{options[:subgrid][:sort_column]}',
+                sortorder: '#{options[:subgrid][:sort_order]}',
+                viewrecords: true,
+                toolbar : [true,"top"], 
+                #{subgrid_inline_edit}
+                #{subgrid_direct_link}
+                height: '100%'
+            })
+            .navGrid("#"+pager_id,{edit:#{options[:subgrid][:edit]},add:#{options[:subgrid][:add]},del:#{options[:subgrid][:delete]},search:false})
+            .navButtonAdd("#"+pager_id,{caption:"Search",title:"Toggle Search",buttonimg:'/images/jquery/search.png',
+              onClickButton:function(){ 
+                if(jQuery("#t_"+subgrid_table_id).css("display")=="none") {
+                  jQuery("#t_"+subgrid_table_id).css("display","");
+                } else {
+                  jQuery("#t_"+subgrid_table_id).css("display","none");
+                }
+              } 
+            });
+            jQuery("#t_"+subgrid_table_id).height(25).hide().filterGrid(""+subgrid_table_id,{gridModel:true,gridToolbar:true});
+          },
+          subGridRowColapsed: function(subgrid_id, row_id) {
+          },
+        )
+      end
+     
+
+      # Generate required Javascript & html to create the jqgrid
+      %Q(
+        <script type="text/javascript">
+        var lastsel_#{id};
+        jQuery(document).ready(function(){
+        jQuery("##{id}").jqGrid({
+            // adding ?nd='+new Date().getTime() prevent IE caching
+            url:'#{action}?nd='+new Date().getTime(),
+            editurl:'#{options[:edit_url]}',
+            datatype: "json",
+            colNames:#{col_names},
+            colModel:#{col_model},
+            pager: jQuery('##{id}_pager'),
+            rowNum:#{options[:rows_per_page]},
+            rowList:[10,25,50,100],
+            sortname: '#{options[:sort_column]}',
+            viewrecords: true,
+            height: #{options[:height]}, 
+            toolbar : [true,"top"],
+            autowidth: #{options[:autowidth]},
+            sortorder: "#{options[:sort_order]}",
+            #{multiselect}
+            #{masterdetails}
+            #{grid_loaded}
+            #{direct_link}
+            #{editable}
+            #{subgrid_enabled}
+            #{subgrid}
+            caption: "#{title}", 
+            hidegrid: #{options[:hidegrid]}
+        });
+        jQuery("#t_#{id}").height(25).hide().filterGrid("#{id}",{gridModel:true,gridToolbar:true});
+        #{multihandler}
+        #{selection_link}
+        jQuery("##{id}").navGrid('##{id}_pager',{edit:#{edit_button},add:#{options[:add]},del:#{options[:delete]},search:false,refresh:true},
+        {afterSubmit:function(r,data){return #{options[:error_handler_return_value]}(r,data,'edit');} #{edit_options}},
+        {afterSubmit:function(r,data){return #{options[:error_handler_return_value]}(r,data,'add');} #{add_options}},
+        {afterSubmit:function(r,data){return #{options[:error_handler_return_value]}(r,data,'delete');} #{del_options}},
+        {#{search_options}}
+        )
+        .navButtonAdd("##{id}_pager",{caption:"Search",title:"Toggle Search",buttonimg:'/images/jquery/search.png',
+          onClickButton:function(){ 
+            if(jQuery("#t_#{id}").css("display")=="none") {
+              jQuery("#t_#{id}").css("display","");
+            } else {
+              jQuery("#t_#{id}").css("display","none");
+            }
+          } 
+        });
+        });
+        </script>
+      )
+    end
+
+    private
+    
+    def gen_columns(columns)
+      # Generate columns data
+      col_names = "[" # Labels
+      col_model = "[" # Options
+      columns.each do |c|
+        col_names << "'#{c[:label]}',"
+        col_model << "{name:'#{c[:field]}', index:'#{c[:field]}'#{get_attributes(c)}},"
+      end
+      col_names.chop! << "]"
+      col_model.chop! << "]"
+      [col_names, col_model]
+    end
+
+    # Generate a list of attributes for related column (align:'right', sortable:true, resizable:false, ...)
+    def get_attributes(column)
+      options = ","
+      column.except(:field, :label).each do |couple|
+        if couple[0] == :editoptions
+          options << "editoptions:#{get_edit_options(couple[1])},"
+        else
+          if couple[1].class == String
+            options << "#{couple[0]}:'#{couple[1]}',"
+          else
+            options << "#{couple[0]}:#{couple[1]},"
+          end
+        end
+      end
+      options.chop!
+    end
+
+    # Generate options for editable fields (value, data, width, maxvalue, cols, rows, ...)
+    def get_edit_options(editoptions)
+      options = "{"
+      editoptions.each do |couple|
+        if couple[0] == :value # :value => [[1, "Rails"], [2, "Ruby"], [3, "jQuery"]]
+          options << %Q/value:"/
+          couple[1].each do |v|
+            options << "#{v[0]}:#{v[1]};"
+          end
+          options.chop! << %Q/",/
+        elsif couple[0] == :data # :data => [Category.all, :id, :title])
+          options << %Q/value:"/
+          couple[1].first.each do |v|
+            options << "#{v[couple[1].second]}:#{v[couple[1].third]};"
+          end
+          options.chop! << %Q/",/
+        else # :size => 30, :rows => 5, :maxlength => 20, ...
+          options << %Q/#{couple[0]}:"#{couple[1]}",/
+        end
+      end
+      options.chop! << "}"
+    end 
+  end
+end
+
+module JqgridJson
+  def to_jqgrid_json(attributes, current_page, per_page, total)
+    json = %Q({"page":"#{current_page}","total":#{total/per_page.to_i+1},"records":"#{total}","rows":[)
+    each do |elem|
+      json << %Q({"id":"#{elem.id}","cell":[)
+      couples = elem.attributes.symbolize_keys
+      attributes.each do |atr|
+        value = couples[atr]
+        value = elem.try(atr) if elem.respond_to?(:try) && value.blank?
+        json << %Q("#{value}",)
+      end
+      json.chop! << "]},"
+    end
+    json.chop! << "]}"
+  end
+end
+
+class Array
+  include JqgridJson
+end