jqgrid_for_rails 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+test/*.log
+test/*.db

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,116 @@
+== JqgridForRails
+
+This is a simple plug-in to create JqGrid(http://www.trirand.com/blog) javascript code easily and cleaner inside rails views.
+
+== Example
+
+There is an example application at:
+
+https://github.com/Juanmcuello/jqgrid_for_rails_example
+
+
+== Installation
+
+To install it as a plugin just:
+
+  $ rails plugin install git@github.com:Juanmcuello/jqgrid_for_rails.git
+
+
+== Views
+
+To generate the grid, you can first create a method in a helper and then call the +jqgrid+ method to generate the java script code. For example, if you have an invoices_helper.rb file, you can define a method there:
+
+  module InvoicesHelper
+
+    include JqgridsHelper
+
+    def invoices_jqgrid
+
+      options = {:html_tags => true}
+      grid_options = {
+        :url => '/invoices',
+        :datatype => 'json',
+        :mtype => 'GET',
+        :colNames => ['Inv No','Date'],
+        :colModel  => [
+          { :name => 'invid',   :index => 'invid',    :width => 55 },
+          { :name => 'invdate', :index => 'invdate',  :width => 90 },
+        ],
+        :pager => '#invoices_pager',
+        :rowNum => 10,
+        :rowList => [10, 20, 30],
+        :caption => 'My first grid',
+        :onSelectRow => "function() { alert('Row selected!');}".to_json_var
+      }
+
+      jqgrid 'invoices_list', options, grid_options
+    end
+  end
+
+Now you can use the helper in the view:
+
+  <%= raw(invoices_jqgrid) %>
+
+Or, if you are using Rails 2.3.x :
+
+  <%= invoices_jqgrid %>
+
+This will result in something like:
+
+  <table id="invoices_list"></table>
+  <div id="invoices_pager"></div>
+  <script>
+    jQuery("#invoices_list").jqGrid({
+      "url": "/invoices",
+      "datatype": "json",
+      "mtype": "GET",
+      "colNames": ["Inv No","Date"],
+      "colModel": [
+        {"name":"invid", "index":"invid", "width":55},
+        {"name":"invdate", "index":"invdate", "width":90}],
+      "pager": "#invoices_pager",
+      "rowNum": 10,
+      "rowList": [10,20,30],
+      "caption": "My first grid",
+      "onSelectRow": function() { alert('Row selected!');}});
+
+    jQuery("#invoices_list").jqGrid("navGrid", "#invoices_pager", {});
+
+  </script
+
+Note: resulting code was indented for clarification.
+
+You can do it better using +content_for+ :
+
+At the views:
+
+  <% content_for :head do %>
+    <%= invoices_jqgrid %>
+  <% end %>
+
+
+Don't forget to include the jquery and jqgrid javascript and stylesheet files!
+
+== Controllers
+
+You can use the +json_for_jqgrid+ method at the controllers to generate the json response for the grid. It receives the records found by the +paginate+ method offered by will_paginate[https://github.com/mislav/will_paginate].
+
+  def index
+
+    @columns = ['invid', 'invdate']
+
+    @invoices = Invoice.paginate(:page => params[:page], :per_page => params[:rows] )
+
+    if request.xhr?
+      render :json => json_for_jqgrid(@invoices, @columns, {:page => params[:page]})
+    end
+  end
+
+
+== Maintainers
+
+* Juan Manuel Cuello (http://github.com/Juanmcuello)
+
+== License
+
+Copyright (c) 2010 Juan M. Cuello, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the jqgrid_for_rails plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << '.'
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the jqgrid_for_rails plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JqgridForRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/helpers/jqgrids_helper.rb

@@ -0,0 +1,101 @@
+module JqgridsHelper
+
+  # Generates the jqGrid javascript code. Also html tags for the table and pager can be generated.
+  # The javascript code is enclosed between the <script> tags.
+  #
+  # The +grid_id+ parameter should be the id of the html table tag that will contain the grid.
+  # If [:html_tags] is +true+, the grid_id will be used when creating the <table> tags.
+  #
+  # === Options
+  #
+  # [:html_tags]
+  #   If true, <table> tag for the grid, and <div> tag for the table will be generated as well.
+  #
+  # [:on_document_ready]
+  #   If true, all the javascript code will be enclosed inside a +jQuery(document).ready+ function
+  #
+  # === Grid Options
+  #
+  # This hash can contain any option accepted by the jqGrid. The has will encoded to json to create
+  # the javascript code for the grid.
+  #
+  # See http://www.trirand.com/jqgridwiki/doku.php?id=wiki:options
+  #
+  # For options that represents javascript functions, the value should be converted to a json_var
+  # using the +to_json_var+ method.
+  #
+  # For example:
+  # :onLoadComplete => "function() { alert('This is a function!');}".to_json_var
+  #
+  # === Nav Options
+  #
+  # This hash can contain any option accepted by the nav options of jqGrid.
+  #
+  # === Example
+  #
+  #  options = {:on_document_ready => true, :html_tags => false}
+  #
+  #  grid_options = {
+  #    :url => '/invoices',
+  #    :datatype => 'json',
+  #    :mtype => 'GET',
+  #    :colNames => ['Inv No','Date', 'Amount','Tax','Total','Notes'],
+  #    :colModel  => [
+  #      { :name => 'invid',   :index => 'invid',    :width => 55 },
+  #      { :name => 'invdate', :index => 'invdate',  :width => 90 },
+  #      { :name => 'amount',  :index => 'amount',   :width => 80,   :align => 'right' },
+  #      { :name => 'tax',     :index => 'tax',      :width => 80,   :align => 'right' },
+  #      { :name => 'total',   :index => 'total',    :width => 80,   :align => 'right' },
+  #      { :name => 'note',    :index => 'note',     :width => 150,  :sortable => false }
+  #    ],
+  #    :pager => '#invoices_pager',
+  #    :rowNum => 10,
+  #    :rowList => [10, 20, 30],
+  #    :sortname => 'invid',
+  #    :sortorder => 'desc',
+  #    :viewrecords => true,
+  #    :caption => 'My first grid',
+  #    :onSelectRow => "function() { alert('Row selected!');}".to_json_var
+  #  }
+  #
+  #  jqgrid 'invoices_list', options, grid_options
+  #
+  def jqgrid grid_id, options = {}, grid_options = {}, nav_options = {}
+
+    html_output = []
+
+    # Table
+    html_output << content_tag(:table, nil, :id => grid_id) if options[:html_tags]
+    js_output   =  "jQuery(\"##{grid_id}\").jqGrid(#{grid_options.to_json});"
+
+    # Pager
+    if grid_options[:pager]
+
+      pager_id = id_from_pager_option(grid_options[:pager])
+
+      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});"
+      end
+    end
+
+    wrap_with_document_ready! js_output if options[:on_document_ready]
+
+    html_output << "<script>" << js_output << "</script>"
+
+    html_output.join("\n")
+  end
+
+private
+
+  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]
+  end
+
+end
+

data/lib/jqgrid_for_rails/controllers/helpers.rb

@@ -0,0 +1,57 @@
+module JqgridForRails
+  module Controllers
+    # Those helpers are convenience methods added to ApplicationController.
+    module Helpers
+      
+      # Returns a json string ready to be send to a jqgrid component.
+      #
+      # +records+ should be the result of an active record query through
+      # the +paginate+ method offered by will_paginate.
+      #
+      # +columns+ is an array with the name of the fields in the order they
+      # should be returned.
+      #
+      # === Options
+      #
+      # [:id_column]
+      #   Says which is the column that should be used as the row id
+      #
+      # :page]
+      #   Says the page number
+      #
+      def json_for_jqgrid records, columns = nil, options = {}
+
+        return if records.empty?
+
+        columns ||= records.first.attributes.keys
+
+        options[:id_column] ||= columns.first
+        options[:page]      ||= 1
+
+        { :page => options[:page],
+          :total => records.total_pages,
+          :records => records.total_entries,
+          :rows => records.map do |r| {
+            :id => r.attributes[options[:id_column]],
+            :cell => r.attributes.values_at(*columns)}
+          end
+        }.to_json
+      end
+
+      # Returns the 'order by' string created using the params received from the jqgrid.
+      #
+      # === Example
+      #
+      #   order_by_from_params({'sidx' => 'updated_at', 'sord' => 'asc'})
+      #   => 'updated_at asc'
+      #
+      def order_by_from_params params
+        order_by = params['sidx'] if params['sidx']
+        order_by << " #{params['sord']}" if params['sord'] && order_by
+        order_by
+      end
+    
+    end
+  end
+end
+

data/lib/jqgrid_for_rails/core_ext.rb

@@ -0,0 +1,5 @@
+String.class_eval do
+  def to_json_var
+    ActiveSupport::JSON::Variable.new(self)
+  end
+end 

data/lib/jqgrid_for_rails.rb

@@ -0,0 +1,13 @@
+# JqgridForRails
+
+require 'jqgrid_for_rails/core_ext'
+require 'jqgrid_for_rails/controllers/helpers'
+
+ActionController::Base.send :include, JqgridForRails::Controllers::Helpers
+
+%w{ models controllers helpers }.each do |dir|
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+end

data/lib/tasks/jqgrid_for_rails.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jqgrid_for_rails do
+#   # Task goes here
+# end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'jqgrid_for_rails'

data/test/controllers/helpers_test.rb

@@ -0,0 +1,29 @@
+require 'test/test_helper' 
+
+class MockController < ApplicationController
+end
+
+class ControllerHelpersTest < ActionController::TestCase
+
+  def setup
+    @controller = MockController.new
+  end
+
+  tests MockController
+
+  test "order_by_from with sidx and sord" do
+    params = {'sidx' => 'updated_at', 'sord' => 'desc' }
+    assert_equal 'updated_at desc', @controller.order_by_from_params(params)
+  end
+
+  test "order_by_from with sidx" do
+    params = {'sidx' => 'updated_at'}
+    assert_equal 'updated_at', @controller.order_by_from_params(params)
+  end
+
+  test "order_by_from without sidx" do
+    params = {'sord' => 'desc' }
+    assert_nil @controller.order_by_from_params(params)
+  end
+
+end

data/test/core_ext_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class CoreExtTest < Test::Unit::TestCase
+
+  def test_string_to_json_var
+    js = 'function() { alert("test"); }'
+    assert_equal( js.to_json_var, js)
+  end
+
+end 
+

data/test/database.yml

@@ -0,0 +1,22 @@
+sqlite:
+  :adapter: sqlite
+  :database: vendor/plugins/jqgrid_for_rails/test/jqgrid_for_rails_plugin.sqlite.db
+
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/jqgrid_for_rails/test/jqgrid_for_rails_plugin.sqlite3.db
+
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: jqgrid_for_rails_plugin_test
+  :min_messages: ERROR
+
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: root 
+  :database: jqgrid_for_rails_plugin_test
+

data/test/jqgrid_for_rails_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class JqgridForRailsTest < Test::Unit::TestCase
+  load_schema
+
+  class Invoices < ActiveRecord::Base
+  end
+
+  def test_schema_has_loaded_correctly
+    assert_equal [], Invoices.all
+  end
+
+end

data/test/jqgrids_helper_test.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class MockView < ActionView::Base
+  include JqgridsHelper
+end
+
+class JqgridsHelperTest < Test::Unit::TestCase
+
+  def test_jqgrid_small
+
+    @template = MockView.new
+
+    grid_id = 'grid_id'
+    options = {:html_tags => true}
+    grid_options = { :url => "/jqGridModel?model=Wine" }
+
+    expected  = '<table id="'+grid_id+'"></table>' + "\n"
+    expected << '<script>' + "\n"
+    expected <<    'jQuery("#'+grid_id+'").jqGrid({"url":"/jqGridModel?model=Wine"});' + "\n"
+    expected << '</script>'
+
+    assert_equal(expected, @template.jqgrid(grid_id, options , grid_options))
+
+  end
+
+  def test_jqgrid_medium
+
+    @template = MockView.new
+
+    grid_id = 'grid_id'
+    pager_id = 'gridpager'
+    grid_options = { :pager => "jQuery('##{pager_id}')".to_json_var }
+
+    options = {:on_document_ready => true }
+    expected = expected_grid(grid_id, pager_id, options)
+    assert_equal(expected, @template.jqgrid(grid_id, options, grid_options))
+
+    options = {:on_document_ready => true, :html_tags => true }
+    expected = expected_grid(grid_id, pager_id, options)
+    assert_equal(expected, @template.jqgrid(grid_id, options, grid_options))
+  end
+
+  def expected_grid grid_id, pager_id, options
+    expected = ''
+    expected << '<table id="'+grid_id+'"></table>' + "\n" if options[:html_tags]
+    expected << '<div id="'+pager_id+'"></div>' + "\n" if options[:html_tags]
+    expected << '<script>' + "\n"
+
+    js =  'jQuery(document).ready(function() {
+            jQuery("#' + grid_id + '").jqGrid({
+              "pager":jQuery(\'#' + pager_id + '\')
+            });
+            jQuery("#grid_id").jqGrid("navGrid", "#gridpager", {});
+          });'
+    expected << js.gsub(/\n\s+/, '') + "\n"
+    expected << '</script>'
+
+  end
+
+end

data/test/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :invoices, :force => true do |t|
+    t.integer   'invid'
+    t.datetime  'invdate'
+    t.float     'amount'
+    t.float     'tax'
+    t.float     'total'
+    t.string    'note'
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+def load_schema 
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||= 
+  begin 
+    require 'rubygems' 
+    require 'sqlite'
+    'sqlite' 
+  rescue MissingSourceFile 
+    begin 
+      require 'sqlite3'
+      'sqlite3' 
+    rescue MissingSourceFile 
+    end 
+  end 
+
+  if db_adapter.nil? 
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end 
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../rails/init.rb'
+
+end
+

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: jqgrid_for_rails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Juan Manuel Cuello
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-06 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Simple solution to create jqgrids easily using Rails
+email: juanmacuello@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- install.rb
+- 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/tasks/jqgrid_for_rails.rake
+- rails/init.rb
+- test/controllers/helpers_test.rb
+- test/core_ext_test.rb
+- test/database.yml
+- test/jqgrid_for_rails_plugin.sqlite3.db
+- test/jqgrid_for_rails_test.rb
+- test/jqgrids_helper_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/Juanmcuello/jqgrid_for_rails
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple solution to create jqgrids easily using Rails
+test_files: []
+