jqgrid_for_rails 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+== 0.2.0
+
+* enhancements
+  * Navigator options fully supported.
+
+* bug fix
+  * Get pager id from the options hash in any of the formats accepted by
+    jqGrid.

data/README.rdoc

@@ -11,9 +11,13 @@ https://github.com/Juanmcuello/jqgrid_for_rails_example
 
 == Installation
 
-To install it as a plugin just:
+As a gem:
 
-  $ rails plugin install git@github.com:Juanmcuello/jqgrid_for_rails.git
+  $ gem install jqgrid_for_rails
+
+As a plugin:
+
+  $ rails plugin install git://github.com/Juanmcuello/jqgrid_for_rails.git
 
 
 == Views

data/jqgrid_for_rails.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jqgrid_for_rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jqgrid_for_rails"
+  s.version     = JqgridForRails::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Simple solution to create jqgrids easily using Rails"
+  s.email       = "juanmacuello@gmail.com"
+  s.homepage    = "http://github.com/Juanmcuello/jqgrid_for_rails"
+  s.description = "Simple solution to create jqgrids easily using Rails"
+  s.authors     = ['Juan Manuel Cuello']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("will_paginate")
+end
+

data/lib/app/helpers/jqgrids_helper.rb

@@ -60,7 +60,7 @@ module JqgridsHelper
   #
   #  jqgrid 'invoices_list', options, grid_options
   #
-  def jqgrid grid_id, options = {}, grid_options = {}, nav_options = {}
+  def jqgrid grid_id, options = {}, grid_options = {}, *nav_options
 
     html_output = []
 
@@ -71,12 +71,12 @@ module JqgridsHelper
     # Pager
     if grid_options[:pager]
 
-      pager_id = id_from_pager_option(grid_options[:pager])
+      pager_id = pager_id_from_options(grid_options)
 
       html_output << content_tag(:div, nil, :id => pager_id) if options[:html_tags]
 
-      if nav_options
-        js_output << "jQuery(\"##{grid_id}\").jqGrid(\"navGrid\", \"##{pager_id}\", #{nav_options.to_json});"
+      unless nav_options.empty?
+        js_output << "jQuery(\"##{grid_id}\").jqGrid(\"navGrid\", \"##{pager_id}\", #{format_nav_options(nav_options)});"
       end
     end
 
@@ -89,12 +89,40 @@ module JqgridsHelper
 
 private
 
+  # Extracts the pager id from the options hash.
+  #
+  # jQgrid accepts three different formats to set the pager id option.
+  #
+  # 1 - jQuery('#my_pager_div')
+  # 2 - #my_pager_div
+  # 3 - my_pager_div
+  #
+  # === Example
+  #
+  #   pager_id_from_options({:pager => "jQuery('#my_pager_id')"})
+  #     => 'my_pager_id'
+  #
+  def pager_id_from_options options
+    pager_option = options[:pager]
+
+    # jQuery('#my_pager_div')
+    if pager_option =~ /^jQuery\(('|")#\w+('|")\)$/
+      pager_option.match(/#\w+/).to_s[1..-1]
+    # #my_pager_div
+    elsif pager_option =~ /^#\w+$/
+      pager_option.match(/#\w+/).to_s[1..-1]
+    # my_pager_div
+    else
+      pager_option
+    end
+  end
+
   def wrap_with_document_ready! str
     str.replace("jQuery(document).ready(function() {#{str}});")
   end
 
-  def id_from_pager_option pager_option
-    pager_option.match(/#\w+/).to_s[1..-1]
+  def format_nav_options nav_options
+    nav_options.map {|e| (e || {}).to_json}.join(', ')
   end
 
 end

data/lib/jqgrid_for_rails/version.rb

@@ -0,0 +1,4 @@
+module JqgridForRails
+  VERSION = "0.2.0".freeze
+end
+

data/test/jqgrids_helper_test.rb

@@ -50,11 +50,41 @@ class JqgridsHelperTest < Test::Unit::TestCase
             jQuery("#' + grid_id + '").jqGrid({
               "pager":jQuery(\'#' + pager_id + '\')
             });
-            jQuery("#grid_id").jqGrid("navGrid", "#gridpager", {});
           });'
     expected << js.gsub(/\n\s+/, '') + "\n"
     expected << '</script>'
 
   end
 
+  def test_jqgrid_nav_options
+    @template = MockView.new
+
+    grid_id = 'grid_id'
+    pager_id = 'pager_id'
+    grid_options = {:pager => "##{pager_id}"}
+    options = {:on_document_ready => true, :html_tags => true}
+    nav_items = {:del => true}
+    del_config = {:closeOnEscape => true}
+
+    expected = '<table id="'+grid_id+'"></table>' + "\n"
+    expected << '<div id="'+pager_id+'"></div>' + "\n"
+    expected << "<script>" + "\n"
+    str =  'jQuery("#'+grid_id+'").jqGrid({"pager":"#'+pager_id+'"});'
+    str << 'jQuery("#'+grid_id+'").jqGrid("navGrid", "#'+pager_id+'", {"del":true}, {}, {}, {"closeOnEscape":true});'
+    expected << "jQuery(document).ready(function() {#{str}});" + "\n"
+    expected << "</script>"
+
+    assert_equal(expected, @template.jqgrid(grid_id,options,grid_options,nav_items,nil,nil,del_config))
+  end
+
+  def testi_pager_id_from_options
+    @template = MockView.new
+
+    assert_equal 'my_pager_div', @template.send(:pager_id_from_options, {:pager => "jQuery('#my_pager_div')"})
+    assert_equal 'my_pager_div', @template.send(:pager_id_from_options, {:pager => 'jQuery("#my_pager_div")'})
+    assert_equal 'my_pager_div', @template.send(:pager_id_from_options, {:pager => "#my_pager_div"})
+    assert_equal 'my_pager_div', @template.send(:pager_id_from_options, {:pager => "my_pager_div"})
+  end
+
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jqgrid_for_rails
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Juan Manuel Cuello
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -03:00
+date: 2011-01-25 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,14 +42,17 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.rdoc
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - install.rb
+- jqgrid_for_rails.gemspec
 - lib/app/helpers/jqgrids_helper.rb
 - lib/jqgrid_for_rails.rb
 - lib/jqgrid_for_rails/controllers/helpers.rb
 - lib/jqgrid_for_rails/core_ext.rb
+- lib/jqgrid_for_rails/version.rb
 - lib/tasks/jqgrid_for_rails.rake
 - rails/init.rb
 - test/controllers/helpers_test.rb